ChRIS Research Integration System: Ultron BackEnd (CUBE) API

AuthToken

authTokenCreate


/api/v1/auth-token/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/x-www-form-urlencoded,multipart/form-data,application/json" \
 "http://localhost/api/v1/auth-token/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthTokenApi;

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

public class AuthTokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthTokenApi apiInstance = new AuthTokenApi();
        String username = username_example; // String | 
        String password = password_example; // String | 

        try {
            AuthToken result = apiInstance.authTokenCreate(username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthTokenApi#authTokenCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String username = new String(); // String | 
final String password = new String(); // String | 

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

import org.openapitools.client.api.AuthTokenApi;

public class AuthTokenApiExample {
    public static void main(String[] args) {
        AuthTokenApi apiInstance = new AuthTokenApi();
        String username = username_example; // String | 
        String password = password_example; // String | 

        try {
            AuthToken result = apiInstance.authTokenCreate(username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthTokenApi#authTokenCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
AuthTokenApi *apiInstance = [[AuthTokenApi alloc] init];
String *username = username_example; //  (default to null)
String *password = password_example; //  (default to null)

[apiInstance authTokenCreateWith:username
    password:password
              completionHandler: ^(AuthToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.AuthTokenApi()
var username = username_example; // {String} 
var password = password_example; // {String} 

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

namespace Example
{
    public class authTokenCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthTokenApi();
            var username = username_example;  // String |  (default to null)
            var password = password_example;  // String |  (default to null)

            try {
                AuthToken result = apiInstance.authTokenCreate(username, password);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthTokenApi.authTokenCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthTokenApi();
$username = username_example; // String | 
$password = password_example; // String | 

try {
    $result = $api_instance->authTokenCreate($username, $password);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthTokenApi->authTokenCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthTokenApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthTokenApi->new();
my $username = username_example; # String | 
my $password = password_example; # String | 

eval {
    my $result = $api_instance->authTokenCreate(username => $username, password => $password);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthTokenApi->authTokenCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.AuthTokenApi()
username = username_example # String |  (default to null)
password = password_example # String |  (default to null)

try:
    api_response = api_instance.auth_token_create(username, password)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthTokenApi->authTokenCreate: %s\n" % e)
extern crate AuthTokenApi;

pub fn main() {
    let username = username_example; // String
    let password = password_example; // String

    let mut context = AuthTokenApi::Context::default();
    let result = client.authTokenCreate(username, password, &context).wait();

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

Scopes

Parameters

Form parameters
Name Description
username*
String
Required
password*
String
Required

Responses


ChrisAdmin

chrisAdminApiV1ComputeresourcesCreate

A JSON view for the collection of compute resources that can be used by ChRIS admins to add a new compute resource through a REST API (alternative to the HTML-based admin site).


/chris-admin/api/v1/computeresources/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/chris-admin/api/v1/computeresources/" \
 -d '{
  "compute_url" : "https://openapi-generator.tech",
  "compute_auth_token" : "compute_auth_token",
  "compute_auth_url" : "https://openapi-generator.tech",
  "compute_innetwork" : true,
  "compute_password" : "compute_password",
  "max_job_exec_seconds" : -1803530559,
  "name" : "name",
  "description" : "description",
  "compute_user" : "compute_user"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        ComputeResourceRequest computeResourceRequest = ; // ComputeResourceRequest | 

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

final api_instance = DefaultApi();

final ComputeResourceRequest computeResourceRequest = new ComputeResourceRequest(); // ComputeResourceRequest | 

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

import org.openapitools.client.api.ChrisAdminApi;

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        ComputeResourceRequest computeResourceRequest = ; // ComputeResourceRequest | 

        try {
            ComputeResource result = apiInstance.chrisAdminApiV1ComputeresourcesCreate(computeResourceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1ComputeresourcesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1ComputeresourcesCreateWith:computeResourceRequest
              completionHandler: ^(ComputeResource output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ChrisAdminApi()
var computeResourceRequest = ; // {ComputeResourceRequest} 

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

namespace Example
{
    public class chrisAdminApiV1ComputeresourcesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ChrisAdminApi();
            var computeResourceRequest = new ComputeResourceRequest(); // ComputeResourceRequest | 

            try {
                ComputeResource result = apiInstance.chrisAdminApiV1ComputeresourcesCreate(computeResourceRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1ComputeresourcesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChrisAdminApi();
$computeResourceRequest = ; // ComputeResourceRequest | 

try {
    $result = $api_instance->chrisAdminApiV1ComputeresourcesCreate($computeResourceRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChrisAdminApi->new();
my $computeResourceRequest = WWW::OPenAPIClient::Object::ComputeResourceRequest->new(); # ComputeResourceRequest | 

eval {
    my $result = $api_instance->chrisAdminApiV1ComputeresourcesCreate(computeResourceRequest => $computeResourceRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ChrisAdminApi()
computeResourceRequest =  # ComputeResourceRequest | 

try:
    api_response = api_instance.chris_admin_api_v1_computeresources_create(computeResourceRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesCreate: %s\n" % e)
extern crate ChrisAdminApi;

pub fn main() {
    let computeResourceRequest = ; // ComputeResourceRequest

    let mut context = ChrisAdminApi::Context::default();
    let result = client.chrisAdminApiV1ComputeresourcesCreate(computeResourceRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
computeResourceRequest *

Responses


chrisAdminApiV1ComputeresourcesDestroy

A JSON view for a compute resource that can be used by ChRIS admins to delete the compute resource through a REST API.


/chris-admin/api/v1/computeresources/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/chris-admin/api/v1/computeresources/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ChrisAdminApi;

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

        try {
            apiInstance.chrisAdminApiV1ComputeresourcesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1ComputeresourcesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1ComputeresourcesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class chrisAdminApiV1ComputeresourcesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.chrisAdminApiV1ComputeresourcesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1ComputeresourcesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->chrisAdminApiV1ComputeresourcesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->chrisAdminApiV1ComputeresourcesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.chris_admin_api_v1_computeresources_destroy(id)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesDestroy: %s\n" % e)
extern crate ChrisAdminApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


chrisAdminApiV1ComputeresourcesList

A JSON view for the collection of compute resources that can be used by ChRIS admins to add a new compute resource through a REST API (alternative to the HTML-based admin site).


/chris-admin/api/v1/computeresources/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/chris-admin/api/v1/computeresources/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedComputeResourceList result = apiInstance.chrisAdminApiV1ComputeresourcesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1ComputeresourcesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.ChrisAdminApi;

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedComputeResourceList result = apiInstance.chrisAdminApiV1ComputeresourcesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1ComputeresourcesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
ChrisAdminApi *apiInstance = [[ChrisAdminApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance chrisAdminApiV1ComputeresourcesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedComputeResourceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ChrisAdminApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class chrisAdminApiV1ComputeresourcesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ChrisAdminApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedComputeResourceList result = apiInstance.chrisAdminApiV1ComputeresourcesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1ComputeresourcesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChrisAdminApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->chrisAdminApiV1ComputeresourcesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChrisAdminApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->chrisAdminApiV1ComputeresourcesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ChrisAdminApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.chris_admin_api_v1_computeresources_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesList: %s\n" % e)
extern crate ChrisAdminApi;

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

    let mut context = ChrisAdminApi::Context::default();
    let result = client.chrisAdminApiV1ComputeresourcesList(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


chrisAdminApiV1ComputeresourcesRetrieve

A JSON view for a compute resource that can be used by ChRIS admins to delete the compute resource through a REST API.


/chris-admin/api/v1/computeresources/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/chris-admin/api/v1/computeresources/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ChrisAdminApi;

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

        try {
            ComputeResource result = apiInstance.chrisAdminApiV1ComputeresourcesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1ComputeresourcesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1ComputeresourcesRetrieveWith:id
              completionHandler: ^(ComputeResource output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class chrisAdminApiV1ComputeresourcesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                ComputeResource result = apiInstance.chrisAdminApiV1ComputeresourcesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1ComputeresourcesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->chrisAdminApiV1ComputeresourcesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->chrisAdminApiV1ComputeresourcesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.chris_admin_api_v1_computeresources_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1ComputeresourcesRetrieve: %s\n" % e)
extern crate ChrisAdminApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


chrisAdminApiV1Create

A JSON view for the collection of plugins that can be used by ChRIS admins to register plugins through a REST API (alternative to the HTML-based admin site).


/chris-admin/api/v1/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/chris-admin/api/v1/" \
 -d '{
  "fname" : "",
  "min_number_of_workers" : -1803530559,
  "max_memory_limit" : 2,
  "max_number_of_workers" : 441289069,
  "min_memory_limit" : 5,
  "execshell" : "execshell",
  "selfpath" : "selfpath",
  "selfexec" : "selfexec",
  "min_cpu_limit" : 1,
  "max_cpu_limit" : 5,
  "description" : "description",
  "min_gpu_limit" : 885365090,
  "version" : "version",
  "dock_image" : "dock_image",
  "compute_names" : "compute_names",
  "plugin_store_url" : "https://openapi-generator.tech",
  "max_gpu_limit" : 1847456234
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        PluginAdminRequest pluginAdminRequest = ; // PluginAdminRequest | 

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

final api_instance = DefaultApi();

final PluginAdminRequest pluginAdminRequest = new PluginAdminRequest(); // PluginAdminRequest | 

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

import org.openapitools.client.api.ChrisAdminApi;

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        PluginAdminRequest pluginAdminRequest = ; // PluginAdminRequest | 

        try {
            PluginAdmin result = apiInstance.chrisAdminApiV1Create(pluginAdminRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1Create");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1CreateWith:pluginAdminRequest
              completionHandler: ^(PluginAdmin output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ChrisAdminApi()
var pluginAdminRequest = ; // {PluginAdminRequest} 

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

namespace Example
{
    public class chrisAdminApiV1CreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ChrisAdminApi();
            var pluginAdminRequest = new PluginAdminRequest(); // PluginAdminRequest | 

            try {
                PluginAdmin result = apiInstance.chrisAdminApiV1Create(pluginAdminRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1Create: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChrisAdminApi();
$pluginAdminRequest = ; // PluginAdminRequest | 

try {
    $result = $api_instance->chrisAdminApiV1Create($pluginAdminRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1Create: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChrisAdminApi->new();
my $pluginAdminRequest = WWW::OPenAPIClient::Object::PluginAdminRequest->new(); # PluginAdminRequest | 

eval {
    my $result = $api_instance->chrisAdminApiV1Create(pluginAdminRequest => $pluginAdminRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1Create: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ChrisAdminApi()
pluginAdminRequest =  # PluginAdminRequest | 

try:
    api_response = api_instance.chris_admin_api_v1_create(pluginAdminRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1Create: %s\n" % e)
extern crate ChrisAdminApi;

pub fn main() {
    let pluginAdminRequest = ; // PluginAdminRequest

    let mut context = ChrisAdminApi::Context::default();
    let result = client.chrisAdminApiV1Create(pluginAdminRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
pluginAdminRequest *

Responses


chrisAdminApiV1Destroy

A JSON view for a plugin that can be used by ChRIS admins to delete the plugin through a REST API.


/chris-admin/api/v1/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/chris-admin/api/v1/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ChrisAdminApi;

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

        try {
            apiInstance.chrisAdminApiV1Destroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1Destroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1DestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class chrisAdminApiV1DestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.chrisAdminApiV1Destroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1Destroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->chrisAdminApiV1Destroy($id);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1Destroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->chrisAdminApiV1Destroy(id => $id);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1Destroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.chris_admin_api_v1_destroy(id)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1Destroy: %s\n" % e)
extern crate ChrisAdminApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


chrisAdminApiV1List

A JSON view for the collection of plugins that can be used by ChRIS admins to register plugins through a REST API (alternative to the HTML-based admin site).


/chris-admin/api/v1/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/chris-admin/api/v1/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginAdminList result = apiInstance.chrisAdminApiV1List(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1List");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.ChrisAdminApi;

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginAdminList result = apiInstance.chrisAdminApiV1List(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1List");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
ChrisAdminApi *apiInstance = [[ChrisAdminApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance chrisAdminApiV1ListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPluginAdminList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ChrisAdminApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class chrisAdminApiV1ListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ChrisAdminApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginAdminList result = apiInstance.chrisAdminApiV1List(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1List: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ChrisAdminApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->chrisAdminApiV1List($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1List: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ChrisAdminApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->chrisAdminApiV1List(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1List: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ChrisAdminApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.chris_admin_api_v1_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1List: %s\n" % e)
extern crate ChrisAdminApi;

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

    let mut context = ChrisAdminApi::Context::default();
    let result = client.chrisAdminApiV1List(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


chrisAdminApiV1Retrieve

A JSON view for a plugin that can be used by ChRIS admins to delete the plugin through a REST API.


/chris-admin/api/v1/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/chris-admin/api/v1/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ChrisAdminApi;

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

        try {
            PluginAdmin result = apiInstance.chrisAdminApiV1Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1Retrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1RetrieveWith:id
              completionHandler: ^(PluginAdmin output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class chrisAdminApiV1RetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                PluginAdmin result = apiInstance.chrisAdminApiV1Retrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1Retrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->chrisAdminApiV1Retrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1Retrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->chrisAdminApiV1Retrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1Retrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.chris_admin_api_v1_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1Retrieve: %s\n" % e)
extern crate ChrisAdminApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


chrisAdminApiV1Update

A JSON view for a plugin that can be used by ChRIS admins to delete the plugin through a REST API.


/chris-admin/api/v1/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/chris-admin/api/v1/{id}/" \
 -d '{
  "fname" : "",
  "min_number_of_workers" : -1803530559,
  "max_memory_limit" : 2,
  "max_number_of_workers" : 441289069,
  "min_memory_limit" : 5,
  "execshell" : "execshell",
  "selfpath" : "selfpath",
  "selfexec" : "selfexec",
  "min_cpu_limit" : 1,
  "max_cpu_limit" : 5,
  "description" : "description",
  "min_gpu_limit" : 885365090,
  "version" : "version",
  "dock_image" : "dock_image",
  "compute_names" : "compute_names",
  "plugin_store_url" : "https://openapi-generator.tech",
  "max_gpu_limit" : 1847456234
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisAdminApi;

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

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ChrisAdminApi;

public class ChrisAdminApiExample {
    public static void main(String[] args) {
        ChrisAdminApi apiInstance = new ChrisAdminApi();
        Integer id = 56; // Integer | 
        PluginAdminRequest pluginAdminRequest = ; // PluginAdminRequest | 

        try {
            PluginAdmin result = apiInstance.chrisAdminApiV1Update(id, pluginAdminRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisAdminApi#chrisAdminApiV1Update");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisAdminApiV1UpdateWith:id
    pluginAdminRequest:pluginAdminRequest
              completionHandler: ^(PluginAdmin output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ChrisAdminApi()
var id = 56; // {Integer} 
var pluginAdminRequest = ; // {PluginAdminRequest} 

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

namespace Example
{
    public class chrisAdminApiV1UpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                PluginAdmin result = apiInstance.chrisAdminApiV1Update(id, pluginAdminRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisAdminApi.chrisAdminApiV1Update: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->chrisAdminApiV1Update($id, $pluginAdminRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisAdminApi->chrisAdminApiV1Update: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisAdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->chrisAdminApiV1Update(id => $id, pluginAdminRequest => $pluginAdminRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisAdminApi->chrisAdminApiV1Update: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ChrisAdminApi()
id = 56 # Integer |  (default to null)
pluginAdminRequest =  # PluginAdminRequest | 

try:
    api_response = api_instance.chris_admin_api_v1_update(id, pluginAdminRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisAdminApi->chrisAdminApiV1Update: %s\n" % e)
extern crate ChrisAdminApi;

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

    let mut context = ChrisAdminApi::Context::default();
    let result = client.chrisAdminApiV1Update(id, pluginAdminRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pluginAdminRequest *

Responses


Chrisinstance

chrisinstanceRetrieve

A compute resource view.


/api/v1/chrisinstance/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/chrisinstance/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ChrisinstanceApi;

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

public class ChrisinstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ChrisinstanceApi;

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

        try {
            ChrisInstance result = apiInstance.chrisinstanceRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChrisinstanceApi#chrisinstanceRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance chrisinstanceRetrieveWith:id
              completionHandler: ^(ChrisInstance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class chrisinstanceRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                ChrisInstance result = apiInstance.chrisinstanceRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ChrisinstanceApi.chrisinstanceRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->chrisinstanceRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChrisinstanceApi->chrisinstanceRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ChrisinstanceApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->chrisinstanceRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChrisinstanceApi->chrisinstanceRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.chrisinstance_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChrisinstanceApi->chrisinstanceRetrieve: %s\n" % e)
extern crate ChrisinstanceApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


Comments

commentsCreate

A view for the collection of comments.


/api/v1/{id}/comments/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/{id}/comments/" \
 -d '{
  "title" : "title",
  "content" : "content"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

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

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer id = 56; // Integer | 
        CommentRequest commentRequest = ; // CommentRequest | 

        try {
            Comment result = apiInstance.commentsCreate(id, commentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance commentsCreateWith:id
    commentRequest:commentRequest
              completionHandler: ^(Comment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.CommentsApi()
var id = 56; // {Integer} 
var opts = {
  'commentRequest':  // {CommentRequest} 
};

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

namespace Example
{
    public class commentsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                Comment result = apiInstance.commentsCreate(id, commentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->commentsCreate($id, $commentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->commentsCreate(id => $id, commentRequest => $commentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.CommentsApi()
id = 56 # Integer |  (default to null)
commentRequest =  # CommentRequest |  (optional)

try:
    api_response = api_instance.comments_create(id, commentRequest=commentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentsCreate: %s\n" % e)
extern crate CommentsApi;

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

    let mut context = CommentsApi::Context::default();
    let result = client.commentsCreate(id, commentRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
commentRequest

Responses


commentsDestroy

A comment view.


/api/v1/comments/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/comments/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

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

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.CommentsApi;

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

        try {
            apiInstance.commentsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance commentsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class commentsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.commentsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->commentsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->commentsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.comments_destroy(id)
except ApiException as e:
    print("Exception when calling CommentsApi->commentsDestroy: %s\n" % e)
extern crate CommentsApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


commentsList

A view for the collection of comments.


/api/v1/{id}/comments/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/comments/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

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

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedCommentList result = apiInstance.commentsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedCommentList result = apiInstance.commentsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance commentsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedCommentList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.CommentsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class commentsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedCommentList result = apiInstance.commentsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->commentsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->commentsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.CommentsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.comments_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentsList: %s\n" % e)
extern crate CommentsApi;

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

    let mut context = CommentsApi::Context::default();
    let result = client.commentsList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


commentsRetrieve

A comment view.


/api/v1/comments/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/comments/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

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

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.CommentsApi;

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

        try {
            Comment result = apiInstance.commentsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance commentsRetrieveWith:id
              completionHandler: ^(Comment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class commentsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                Comment result = apiInstance.commentsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->commentsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->commentsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.comments_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentsRetrieve: %s\n" % e)
extern crate CommentsApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


commentsSearchList

A view for the collection of feed-specific comments resulting from a query search.


/api/v1/{id}/comments/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/comments/search/?id=56&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

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

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentsApi apiInstance = new CommentsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedCommentList result = apiInstance.commentsSearchList(id, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedCommentList result = apiInstance.commentsSearchList(id, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
CommentsApi *apiInstance = [[CommentsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance commentsSearchListWith:id
    id2:id2
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedCommentList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.CommentsApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class commentsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentsApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedCommentList result = apiInstance.commentsSearchList(id, id2, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->commentsSearchList($id, $id2, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentsApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->commentsSearchList(id => $id, id2 => $id2, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.CommentsApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.comments_search_list(id, id2=id2, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentsSearchList: %s\n" % e)
extern crate CommentsApi;

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

    let mut context = CommentsApi::Context::default();
    let result = client.commentsSearchList(id, id2, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


commentsUpdate

A comment view.


/api/v1/comments/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/comments/{id}/" \
 -d '{
  "title" : "title",
  "content" : "content"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

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

public class CommentsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.CommentsApi;

public class CommentsApiExample {
    public static void main(String[] args) {
        CommentsApi apiInstance = new CommentsApi();
        Integer id = 56; // Integer | 
        CommentRequest commentRequest = ; // CommentRequest | 

        try {
            Comment result = apiInstance.commentsUpdate(id, commentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#commentsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance commentsUpdateWith:id
    commentRequest:commentRequest
              completionHandler: ^(Comment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.CommentsApi()
var id = 56; // {Integer} 
var opts = {
  'commentRequest':  // {CommentRequest} 
};

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

namespace Example
{
    public class commentsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                Comment result = apiInstance.commentsUpdate(id, commentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentsApi.commentsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->commentsUpdate($id, $commentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->commentsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->commentsUpdate(id => $id, commentRequest => $commentRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentsApi->commentsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.CommentsApi()
id = 56 # Integer |  (default to null)
commentRequest =  # CommentRequest |  (optional)

try:
    api_response = api_instance.comments_update(id, commentRequest=commentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentsApi->commentsUpdate: %s\n" % e)
extern crate CommentsApi;

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

    let mut context = CommentsApi::Context::default();
    let result = client.commentsUpdate(id, commentRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
commentRequest

Responses


Computeresources

computeresourcesList

A view for the collection of compute resources.


/api/v1/computeresources/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/computeresources/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ComputeresourcesApi;

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

public class ComputeresourcesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ComputeresourcesApi apiInstance = new ComputeresourcesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedComputeResourceList result = apiInstance.computeresourcesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComputeresourcesApi#computeresourcesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.ComputeresourcesApi;

public class ComputeresourcesApiExample {
    public static void main(String[] args) {
        ComputeresourcesApi apiInstance = new ComputeresourcesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedComputeResourceList result = apiInstance.computeresourcesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComputeresourcesApi#computeresourcesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
ComputeresourcesApi *apiInstance = [[ComputeresourcesApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance computeresourcesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedComputeResourceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ComputeresourcesApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class computeresourcesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ComputeresourcesApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedComputeResourceList result = apiInstance.computeresourcesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ComputeresourcesApi.computeresourcesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ComputeresourcesApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->computeresourcesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComputeresourcesApi->computeresourcesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ComputeresourcesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ComputeresourcesApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->computeresourcesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ComputeresourcesApi->computeresourcesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ComputeresourcesApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.computeresources_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputeresourcesApi->computeresourcesList: %s\n" % e)
extern crate ComputeresourcesApi;

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

    let mut context = ComputeresourcesApi::Context::default();
    let result = client.computeresourcesList(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


computeresourcesRetrieve

A compute resource view.


/api/v1/computeresources/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/computeresources/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ComputeresourcesApi;

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

public class ComputeresourcesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.ComputeresourcesApi;

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

        try {
            ComputeResource result = apiInstance.computeresourcesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComputeresourcesApi#computeresourcesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance computeresourcesRetrieveWith:id
              completionHandler: ^(ComputeResource output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class computeresourcesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                ComputeResource result = apiInstance.computeresourcesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ComputeresourcesApi.computeresourcesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->computeresourcesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComputeresourcesApi->computeresourcesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ComputeresourcesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->computeresourcesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ComputeresourcesApi->computeresourcesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.computeresources_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputeresourcesApi->computeresourcesRetrieve: %s\n" % e)
extern crate ComputeresourcesApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


computeresourcesSearchList

A view for the collection of compute resources resulting from a query search.


/api/v1/computeresources/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/computeresources/search/?description=description_example&id=56&limit=56&name=name_example&name_exact=nameExact_example&offset=56&plugin_id=pluginId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ComputeresourcesApi;

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

public class ComputeresourcesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ComputeresourcesApi apiInstance = new ComputeresourcesApi();
        String description = description_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        String name = name_example; // String | 
        String nameExact = nameExact_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String pluginId = pluginId_example; // String | 

        try {
            PaginatedComputeResourceList result = apiInstance.computeresourcesSearchList(description, id, limit, name, nameExact, offset, pluginId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComputeresourcesApi#computeresourcesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String description = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final String name = new String(); // String | 
final String nameExact = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String pluginId = new String(); // String | 

try {
    final result = await api_instance.computeresourcesSearchList(description, id, limit, name, nameExact, offset, pluginId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->computeresourcesSearchList: $e\n');
}

import org.openapitools.client.api.ComputeresourcesApi;

public class ComputeresourcesApiExample {
    public static void main(String[] args) {
        ComputeresourcesApi apiInstance = new ComputeresourcesApi();
        String description = description_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        String name = name_example; // String | 
        String nameExact = nameExact_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String pluginId = pluginId_example; // String | 

        try {
            PaginatedComputeResourceList result = apiInstance.computeresourcesSearchList(description, id, limit, name, nameExact, offset, pluginId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComputeresourcesApi#computeresourcesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
ComputeresourcesApi *apiInstance = [[ComputeresourcesApi alloc] init];
String *description = description_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
String *nameExact = nameExact_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *pluginId = pluginId_example; //  (optional) (default to null)

[apiInstance computeresourcesSearchListWith:description
    id:id
    limit:limit
    name:name
    nameExact:nameExact
    offset:offset
    pluginId:pluginId
              completionHandler: ^(PaginatedComputeResourceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.ComputeresourcesApi()
var opts = {
  'description': description_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'name': name_example, // {String} 
  'nameExact': nameExact_example, // {String} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'pluginId': pluginId_example // {String} 
};

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

namespace Example
{
    public class computeresourcesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ComputeresourcesApi();
            var description = description_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var nameExact = nameExact_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var pluginId = pluginId_example;  // String |  (optional)  (default to null)

            try {
                PaginatedComputeResourceList result = apiInstance.computeresourcesSearchList(description, id, limit, name, nameExact, offset, pluginId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ComputeresourcesApi.computeresourcesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ComputeresourcesApi();
$description = description_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$name = name_example; // String | 
$nameExact = nameExact_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.
$pluginId = pluginId_example; // String | 

try {
    $result = $api_instance->computeresourcesSearchList($description, $id, $limit, $name, $nameExact, $offset, $pluginId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComputeresourcesApi->computeresourcesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ComputeresourcesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ComputeresourcesApi->new();
my $description = description_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $name = name_example; # String | 
my $nameExact = nameExact_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $pluginId = pluginId_example; # String | 

eval {
    my $result = $api_instance->computeresourcesSearchList(description => $description, id => $id, limit => $limit, name => $name, nameExact => $nameExact, offset => $offset, pluginId => $pluginId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ComputeresourcesApi->computeresourcesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.ComputeresourcesApi()
description = description_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
name = name_example # String |  (optional) (default to null)
nameExact = nameExact_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
pluginId = pluginId_example # String |  (optional) (default to null)

try:
    api_response = api_instance.computeresources_search_list(description=description, id=id, limit=limit, name=name, nameExact=nameExact, offset=offset, pluginId=pluginId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputeresourcesApi->computeresourcesSearchList: %s\n" % e)
extern crate ComputeresourcesApi;

pub fn main() {
    let description = description_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let name = name_example; // String
    let nameExact = nameExact_example; // String
    let offset = 56; // Integer
    let pluginId = pluginId_example; // String

    let mut context = ComputeresourcesApi::Context::default();
    let result = client.computeresourcesSearchList(description, id, limit, name, nameExact, offset, pluginId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
description
String
id
Integer
limit
Integer
Number of results to return per page.
name
String
name_exact
String
offset
Integer
The initial index from which to return the results.
plugin_id
String

Responses


Default

rootDestroy

A feed view.


/api/v1/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.DefaultApi;

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

        try {
            apiInstance.rootDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#rootDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance rootDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class rootDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.rootDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.rootDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->rootDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->rootDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->rootDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling DefaultApi->rootDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.root_destroy(id)
except ApiException as e:
    print("Exception when calling DefaultApi->rootDestroy: %s\n" % e)
extern crate DefaultApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


rootList

A view for the collection of feeds. This is also the API's "homepage".


/api/v1/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.rootList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#rootList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.rootList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#rootList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance rootListWith:limit
    offset:offset
              completionHandler: ^(PaginatedFeedList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.DefaultApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class rootListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedList result = apiInstance.rootList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.rootList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->rootList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->rootList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->rootList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->rootList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.DefaultApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.root_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rootList: %s\n" % e)
extern crate DefaultApi;

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

    let mut context = DefaultApi::Context::default();
    let result = client.rootList(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


rootRetrieve

A feed view.


/api/v1/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.DefaultApi;

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

        try {
            Feed result = apiInstance.rootRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#rootRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance rootRetrieveWith:id
              completionHandler: ^(Feed output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class rootRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                Feed result = apiInstance.rootRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.rootRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->rootRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->rootRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->rootRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->rootRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.root_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rootRetrieve: %s\n" % e)
extern crate DefaultApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


rootUpdate

A feed view.


/api/v1/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/{id}/" \
 -d '{
  "public" : true,
  "name" : "name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Integer id = 56; // Integer | 
        FeedRequest feedRequest = ; // FeedRequest | 

        try {
            Feed result = apiInstance.rootUpdate(id, feedRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#rootUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance rootUpdateWith:id
    feedRequest:feedRequest
              completionHandler: ^(Feed output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.DefaultApi()
var id = 56; // {Integer} 
var opts = {
  'feedRequest':  // {FeedRequest} 
};

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

namespace Example
{
    public class rootUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                Feed result = apiInstance.rootUpdate(id, feedRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.rootUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->rootUpdate($id, $feedRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->rootUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->rootUpdate(id => $id, feedRequest => $feedRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->rootUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.DefaultApi()
id = 56 # Integer |  (default to null)
feedRequest =  # FeedRequest |  (optional)

try:
    api_response = api_instance.root_update(id, feedRequest=feedRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rootUpdate: %s\n" % e)
extern crate DefaultApi;

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

    let mut context = DefaultApi::Context::default();
    let result = client.rootUpdate(id, feedRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
feedRequest

Responses


Downloadtokens

downloadtokensCreate

A view for the collection of user-specific file download tokens.


/api/v1/downloadtokens/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/downloadtokens/" \
 -d '{
  "token" : "token"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DownloadtokensApi;

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

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DownloadtokensApi apiInstance = new DownloadtokensApi();
        FileDownloadTokenRequest fileDownloadTokenRequest = ; // FileDownloadTokenRequest | 

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

final api_instance = DefaultApi();

final FileDownloadTokenRequest fileDownloadTokenRequest = new FileDownloadTokenRequest(); // FileDownloadTokenRequest | 

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

import org.openapitools.client.api.DownloadtokensApi;

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        DownloadtokensApi apiInstance = new DownloadtokensApi();
        FileDownloadTokenRequest fileDownloadTokenRequest = ; // FileDownloadTokenRequest | 

        try {
            FileDownloadToken result = apiInstance.downloadtokensCreate(fileDownloadTokenRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadtokensApi#downloadtokensCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
DownloadtokensApi *apiInstance = [[DownloadtokensApi alloc] init];
FileDownloadTokenRequest *fileDownloadTokenRequest = ; //  (optional)

[apiInstance downloadtokensCreateWith:fileDownloadTokenRequest
              completionHandler: ^(FileDownloadToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.DownloadtokensApi()
var opts = {
  'fileDownloadTokenRequest':  // {FileDownloadTokenRequest} 
};

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

namespace Example
{
    public class downloadtokensCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DownloadtokensApi();
            var fileDownloadTokenRequest = new FileDownloadTokenRequest(); // FileDownloadTokenRequest |  (optional) 

            try {
                FileDownloadToken result = apiInstance.downloadtokensCreate(fileDownloadTokenRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DownloadtokensApi.downloadtokensCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DownloadtokensApi();
$fileDownloadTokenRequest = ; // FileDownloadTokenRequest | 

try {
    $result = $api_instance->downloadtokensCreate($fileDownloadTokenRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DownloadtokensApi->downloadtokensCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DownloadtokensApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DownloadtokensApi->new();
my $fileDownloadTokenRequest = WWW::OPenAPIClient::Object::FileDownloadTokenRequest->new(); # FileDownloadTokenRequest | 

eval {
    my $result = $api_instance->downloadtokensCreate(fileDownloadTokenRequest => $fileDownloadTokenRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DownloadtokensApi->downloadtokensCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.DownloadtokensApi()
fileDownloadTokenRequest =  # FileDownloadTokenRequest |  (optional)

try:
    api_response = api_instance.downloadtokens_create(fileDownloadTokenRequest=fileDownloadTokenRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DownloadtokensApi->downloadtokensCreate: %s\n" % e)
extern crate DownloadtokensApi;

pub fn main() {
    let fileDownloadTokenRequest = ; // FileDownloadTokenRequest

    let mut context = DownloadtokensApi::Context::default();
    let result = client.downloadtokensCreate(fileDownloadTokenRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
fileDownloadTokenRequest

Responses


downloadtokensList

A view for the collection of user-specific file download tokens.


/api/v1/downloadtokens/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/downloadtokens/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DownloadtokensApi;

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

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DownloadtokensApi apiInstance = new DownloadtokensApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileDownloadTokenList result = apiInstance.downloadtokensList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadtokensApi#downloadtokensList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.DownloadtokensApi;

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        DownloadtokensApi apiInstance = new DownloadtokensApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileDownloadTokenList result = apiInstance.downloadtokensList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadtokensApi#downloadtokensList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
DownloadtokensApi *apiInstance = [[DownloadtokensApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance downloadtokensListWith:limit
    offset:offset
              completionHandler: ^(PaginatedFileDownloadTokenList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.DownloadtokensApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class downloadtokensListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DownloadtokensApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileDownloadTokenList result = apiInstance.downloadtokensList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DownloadtokensApi.downloadtokensList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DownloadtokensApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->downloadtokensList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DownloadtokensApi->downloadtokensList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DownloadtokensApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DownloadtokensApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->downloadtokensList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DownloadtokensApi->downloadtokensList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.DownloadtokensApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.downloadtokens_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DownloadtokensApi->downloadtokensList: %s\n" % e)
extern crate DownloadtokensApi;

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

    let mut context = DownloadtokensApi::Context::default();
    let result = client.downloadtokensList(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


downloadtokensRetrieve

A file download token view.


/api/v1/downloadtokens/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/downloadtokens/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DownloadtokensApi;

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

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.DownloadtokensApi;

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

        try {
            FileDownloadToken result = apiInstance.downloadtokensRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadtokensApi#downloadtokensRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance downloadtokensRetrieveWith:id
              completionHandler: ^(FileDownloadToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class downloadtokensRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileDownloadToken result = apiInstance.downloadtokensRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DownloadtokensApi.downloadtokensRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->downloadtokensRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DownloadtokensApi->downloadtokensRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DownloadtokensApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->downloadtokensRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DownloadtokensApi->downloadtokensRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.downloadtokens_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DownloadtokensApi->downloadtokensRetrieve: %s\n" % e)
extern crate DownloadtokensApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


downloadtokensSearchList

A view for the collection of user-specific file download tokens resulting from a query search.


/api/v1/downloadtokens/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/downloadtokens/search/?id=56&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DownloadtokensApi;

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

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DownloadtokensApi apiInstance = new DownloadtokensApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileDownloadTokenList result = apiInstance.downloadtokensSearchList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadtokensApi#downloadtokensSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.DownloadtokensApi;

public class DownloadtokensApiExample {
    public static void main(String[] args) {
        DownloadtokensApi apiInstance = new DownloadtokensApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileDownloadTokenList result = apiInstance.downloadtokensSearchList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadtokensApi#downloadtokensSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
DownloadtokensApi *apiInstance = [[DownloadtokensApi alloc] init];
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance downloadtokensSearchListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileDownloadTokenList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.DownloadtokensApi()
var opts = {
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class downloadtokensSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DownloadtokensApi();
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileDownloadTokenList result = apiInstance.downloadtokensSearchList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DownloadtokensApi.downloadtokensSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DownloadtokensApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->downloadtokensSearchList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DownloadtokensApi->downloadtokensSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DownloadtokensApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DownloadtokensApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->downloadtokensSearchList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DownloadtokensApi->downloadtokensSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.DownloadtokensApi()
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.downloadtokens_search_list(id=id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DownloadtokensApi->downloadtokensSearchList: %s\n" % e)
extern crate DownloadtokensApi;

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

    let mut context = DownloadtokensApi::Context::default();
    let result = client.downloadtokensSearchList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


Filebrowser

filebrowserChildrenList

A view for the collection of folders that are the children of this folder.


/api/v1/filebrowser/{id}/children/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/children/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderList result = apiInstance.filebrowserChildrenList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserChildrenList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderList result = apiInstance.filebrowserChildrenList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserChildrenList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserChildrenListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFolderList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserChildrenListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderList result = apiInstance.filebrowserChildrenList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserChildrenList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserChildrenList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserChildrenList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserChildrenList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserChildrenList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_children_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserChildrenList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserChildrenList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserCreate

A view for the initial page of the collection of file browser folders. The returned collection only has a single element.


/api/v1/filebrowser/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/" \
 -d '{
  "path" : "path",
  "public" : true
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        FileBrowserFolderRequest fileBrowserFolderRequest = ; // FileBrowserFolderRequest | 

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

final api_instance = DefaultApi();

final FileBrowserFolderRequest fileBrowserFolderRequest = new FileBrowserFolderRequest(); // FileBrowserFolderRequest | 

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        FileBrowserFolderRequest fileBrowserFolderRequest = ; // FileBrowserFolderRequest | 

        try {
            FileBrowserFolder result = apiInstance.filebrowserCreate(fileBrowserFolderRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
FileBrowserFolderRequest *fileBrowserFolderRequest = ; //  (optional)

[apiInstance filebrowserCreateWith:fileBrowserFolderRequest
              completionHandler: ^(FileBrowserFolder output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var opts = {
  'fileBrowserFolderRequest':  // {FileBrowserFolderRequest} 
};

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

namespace Example
{
    public class filebrowserCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var fileBrowserFolderRequest = new FileBrowserFolderRequest(); // FileBrowserFolderRequest |  (optional) 

            try {
                FileBrowserFolder result = apiInstance.filebrowserCreate(fileBrowserFolderRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$fileBrowserFolderRequest = ; // FileBrowserFolderRequest | 

try {
    $result = $api_instance->filebrowserCreate($fileBrowserFolderRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $fileBrowserFolderRequest = WWW::OPenAPIClient::Object::FileBrowserFolderRequest->new(); # FileBrowserFolderRequest | 

eval {
    my $result = $api_instance->filebrowserCreate(fileBrowserFolderRequest => $fileBrowserFolderRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
fileBrowserFolderRequest =  # FileBrowserFolderRequest |  (optional)

try:
    api_response = api_instance.filebrowser_create(fileBrowserFolderRequest=fileBrowserFolderRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserCreate: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let fileBrowserFolderRequest = ; // FileBrowserFolderRequest

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserCreate(fileBrowserFolderRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
fileBrowserFolderRequest

Responses


filebrowserDestroy

A ChRIS folder view.


/api/v1/filebrowser/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFiles.Retrieve

Overriden to be able to make a GET request to an actual file resource.


/api/v1/filebrowser/files/{id}/.

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
 \
-H "download_token: [[apiKey]]" \
 -H "Accept: */*" \
 "http://localhost/api/v1/filebrowser/files/{id}/."
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: DownloadTokenInQueryString
        ApiKeyAuth DownloadTokenInQueryString = (ApiKeyAuth) defaultClient.getAuthentication("DownloadTokenInQueryString");
        DownloadTokenInQueryString.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //DownloadTokenInQueryString.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.filebrowserFiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFiles.Retrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];

// Configure API key authorization: (authentication scheme: DownloadTokenInQueryString)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"download_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"download_token"];


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

[apiInstance filebrowserFiles.RetrieveWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Configure API key authorization: DownloadTokenInQueryString
var DownloadTokenInQueryString = defaultClient.authentications['DownloadTokenInQueryString'];
DownloadTokenInQueryString.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//DownloadTokenInQueryString.apiKeyPrefix['download_token'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = id_example; // {String} 

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

namespace Example
{
    public class filebrowserFiles.RetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: DownloadTokenInQueryString
            Configuration.Default.ApiKey.Add("download_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("download_token", "Bearer");

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

            try {
                File result = apiInstance.filebrowserFiles.Retrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFiles.Retrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Configure API key authorization: DownloadTokenInQueryString
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('download_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('download_token', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFiles.Retrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFiles.Retrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Configure API key authorization: DownloadTokenInQueryString
$WWW::OPenAPIClient::Configuration::api_key->{'download_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'download_token'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFiles.Retrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFiles.Retrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Configure API key authorization: DownloadTokenInQueryString
chris_oag.configuration.api_key['download_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['download_token'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = id_example # String |  (default to null)

try:
    api_response = api_instance.filebrowser_files/retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFiles.Retrieve: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFiles.Retrieve(id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses


filebrowserFilesDestroy

A ChRIS file view.


/api/v1/filebrowser/files/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/files/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserFilesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserFilesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserFilesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserFilesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserFilesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_files_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFilesGrouppermissionsCreate

A view for a file's collection of group permissions.


/api/v1/filebrowser/files/{id}/grouppermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/files/{id}/grouppermissions/" \
 -d '{
  "grp_name" : "grp_name",
  "permission" : "r"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFileGroupPermissionRequest fileBrowserFileGroupPermissionRequest = ; // FileBrowserFileGroupPermissionRequest | 

        try {
            FileBrowserFileGroupPermission result = apiInstance.filebrowserFilesGrouppermissionsCreate(id, fileBrowserFileGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesGrouppermissionsCreateWith:id
    fileBrowserFileGroupPermissionRequest:fileBrowserFileGroupPermissionRequest
              completionHandler: ^(FileBrowserFileGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFileGroupPermissionRequest':  // {FileBrowserFileGroupPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserFilesGrouppermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFileGroupPermission result = apiInstance.filebrowserFilesGrouppermissionsCreate(id, fileBrowserFileGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesGrouppermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesGrouppermissionsCreate($id, $fileBrowserFileGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesGrouppermissionsCreate(id => $id, fileBrowserFileGroupPermissionRequest => $fileBrowserFileGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFileGroupPermissionRequest =  # FileBrowserFileGroupPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_files_grouppermissions_create(id, fileBrowserFileGroupPermissionRequest=fileBrowserFileGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsCreate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesGrouppermissionsCreate(id, fileBrowserFileGroupPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFileGroupPermissionRequest

Responses


filebrowserFilesGrouppermissionsDestroy

A view for a file's group permission.


/api/v1/filebrowser/files/grouppermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/files/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserFilesGrouppermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesGrouppermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserFilesGrouppermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserFilesGrouppermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesGrouppermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserFilesGrouppermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserFilesGrouppermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_files_grouppermissions_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFilesGrouppermissionsList

A view for a file's collection of group permissions.


/api/v1/filebrowser/files/{id}/grouppermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/{id}/grouppermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileGroupPermissionList result = apiInstance.filebrowserFilesGrouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileGroupPermissionList result = apiInstance.filebrowserFilesGrouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserFilesGrouppermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFileGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserFilesGrouppermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFileGroupPermissionList result = apiInstance.filebrowserFilesGrouppermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesGrouppermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserFilesGrouppermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserFilesGrouppermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_files_grouppermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesGrouppermissionsList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserFilesGrouppermissionsRetrieve

A view for a file's group permission.


/api/v1/filebrowser/files/grouppermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserFileGroupPermission result = apiInstance.filebrowserFilesGrouppermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesGrouppermissionsRetrieveWith:id
              completionHandler: ^(FileBrowserFileGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserFilesGrouppermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFileGroupPermission result = apiInstance.filebrowserFilesGrouppermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesGrouppermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesGrouppermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesGrouppermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_files_grouppermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFilesGrouppermissionsSearchList

A view for the collection of file-specific group permissions resulting from a query search.


/api/v1/filebrowser/files/{id}/grouppermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/{id}/grouppermissions/search/?group_name=groupName_example&id=56&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileGroupPermissionList result = apiInstance.filebrowserFilesGrouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String groupName = new String(); // String | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileGroupPermissionList result = apiInstance.filebrowserFilesGrouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
String *groupName = groupName_example; //  (optional) (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserFilesGrouppermissionsSearchListWith:id
    groupName:groupName
    id2:id2
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFileGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'groupName': groupName_example, // {String} 
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserFilesGrouppermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var groupName = groupName_example;  // String |  (optional)  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFileGroupPermissionList result = apiInstance.filebrowserFilesGrouppermissionsSearchList(id, groupName, id2, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesGrouppermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$groupName = groupName_example; // String | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserFilesGrouppermissionsSearchList($id, $groupName, $id2, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $groupName = groupName_example; # String | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserFilesGrouppermissionsSearchList(id => $id, groupName => $groupName, id2 => $id2, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
groupName = groupName_example # String |  (optional) (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_files_grouppermissions_search_list(id, groupName=groupName, id2=id2, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsSearchList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let groupName = groupName_example; // String
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesGrouppermissionsSearchList(id, groupName, id2, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
group_name
String
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserFilesGrouppermissionsUpdate

A view for a file's group permission.


/api/v1/filebrowser/files/grouppermissions/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/files/grouppermissions/{id}/" \
 -d '{
  "grp_name" : "grp_name",
  "permission" : "r"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFileGroupPermissionRequest fileBrowserFileGroupPermissionRequest = ; // FileBrowserFileGroupPermissionRequest | 

        try {
            FileBrowserFileGroupPermission result = apiInstance.filebrowserFilesGrouppermissionsUpdate(id, fileBrowserFileGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesGrouppermissionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesGrouppermissionsUpdateWith:id
    fileBrowserFileGroupPermissionRequest:fileBrowserFileGroupPermissionRequest
              completionHandler: ^(FileBrowserFileGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFileGroupPermissionRequest':  // {FileBrowserFileGroupPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserFilesGrouppermissionsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFileGroupPermission result = apiInstance.filebrowserFilesGrouppermissionsUpdate(id, fileBrowserFileGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesGrouppermissionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesGrouppermissionsUpdate($id, $fileBrowserFileGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesGrouppermissionsUpdate(id => $id, fileBrowserFileGroupPermissionRequest => $fileBrowserFileGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFileGroupPermissionRequest =  # FileBrowserFileGroupPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_files_grouppermissions_update(id, fileBrowserFileGroupPermissionRequest=fileBrowserFileGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesGrouppermissionsUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesGrouppermissionsUpdate(id, fileBrowserFileGroupPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFileGroupPermissionRequest

Responses


filebrowserFilesList

A view for the collection of all the files directly under this folder.


/api/v1/filebrowser/{id}/files/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/files/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileList result = apiInstance.filebrowserFilesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileList result = apiInstance.filebrowserFilesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserFilesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserFilesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFileList result = apiInstance.filebrowserFilesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserFilesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserFilesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_files_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserFilesRetrieve

A ChRIS file view.


/api/v1/filebrowser/files/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserFile result = apiInstance.filebrowserFilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesRetrieveWith:id
              completionHandler: ^(FileBrowserFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserFilesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFile result = apiInstance.filebrowserFilesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_files_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFilesUpdate

A ChRIS file view.


/api/v1/filebrowser/files/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/files/{id}/" \
 -d '{
  "fname" : "",
  "public" : true,
  "new_file_path" : "new_file_path"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFileRequest fileBrowserFileRequest = ; // FileBrowserFileRequest | 

        try {
            FileBrowserFile result = apiInstance.filebrowserFilesUpdate(id, fileBrowserFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesUpdateWith:id
    fileBrowserFileRequest:fileBrowserFileRequest
              completionHandler: ^(FileBrowserFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFileRequest':  // {FileBrowserFileRequest} 
};

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

namespace Example
{
    public class filebrowserFilesUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFile result = apiInstance.filebrowserFilesUpdate(id, fileBrowserFileRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesUpdate($id, $fileBrowserFileRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesUpdate(id => $id, fileBrowserFileRequest => $fileBrowserFileRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFileRequest =  # FileBrowserFileRequest |  (optional)

try:
    api_response = api_instance.filebrowser_files_update(id, fileBrowserFileRequest=fileBrowserFileRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesUpdate(id, fileBrowserFileRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFileRequest

Responses


filebrowserFilesUserpermissionsCreate

A view for a file's collection of user permissions.


/api/v1/filebrowser/files/{id}/userpermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/files/{id}/userpermissions/" \
 -d '{
  "permission" : "r",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFileUserPermissionRequest fileBrowserFileUserPermissionRequest = ; // FileBrowserFileUserPermissionRequest | 

        try {
            FileBrowserFileUserPermission result = apiInstance.filebrowserFilesUserpermissionsCreate(id, fileBrowserFileUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesUserpermissionsCreateWith:id
    fileBrowserFileUserPermissionRequest:fileBrowserFileUserPermissionRequest
              completionHandler: ^(FileBrowserFileUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFileUserPermissionRequest':  // {FileBrowserFileUserPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserFilesUserpermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFileUserPermission result = apiInstance.filebrowserFilesUserpermissionsCreate(id, fileBrowserFileUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUserpermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesUserpermissionsCreate($id, $fileBrowserFileUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesUserpermissionsCreate(id => $id, fileBrowserFileUserPermissionRequest => $fileBrowserFileUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFileUserPermissionRequest =  # FileBrowserFileUserPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_files_userpermissions_create(id, fileBrowserFileUserPermissionRequest=fileBrowserFileUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsCreate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesUserpermissionsCreate(id, fileBrowserFileUserPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFileUserPermissionRequest

Responses


filebrowserFilesUserpermissionsDestroy

A view for a file's user permission.


/api/v1/filebrowser/files/userpermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/files/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserFilesUserpermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesUserpermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserFilesUserpermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserFilesUserpermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUserpermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserFilesUserpermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserFilesUserpermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_files_userpermissions_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFilesUserpermissionsList

A view for a file's collection of user permissions.


/api/v1/filebrowser/files/{id}/userpermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/{id}/userpermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileUserPermissionList result = apiInstance.filebrowserFilesUserpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFileUserPermissionList result = apiInstance.filebrowserFilesUserpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserFilesUserpermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFileUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserFilesUserpermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFileUserPermissionList result = apiInstance.filebrowserFilesUserpermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUserpermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserFilesUserpermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserFilesUserpermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_files_userpermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesUserpermissionsList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserFilesUserpermissionsRetrieve

A view for a file's user permission.


/api/v1/filebrowser/files/userpermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserFileUserPermission result = apiInstance.filebrowserFilesUserpermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesUserpermissionsRetrieveWith:id
              completionHandler: ^(FileBrowserFileUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserFilesUserpermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFileUserPermission result = apiInstance.filebrowserFilesUserpermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUserpermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesUserpermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesUserpermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_files_userpermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserFilesUserpermissionsSearchList

A view for the collection of file-specific user permissions resulting from a query search.


/api/v1/filebrowser/files/{id}/userpermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/files/{id}/userpermissions/search/?id=56&limit=56&offset=56&username=username_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFileBrowserFileUserPermissionList result = apiInstance.filebrowserFilesUserpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String username = new String(); // String | 

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFileBrowserFileUserPermissionList result = apiInstance.filebrowserFilesUserpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *username = username_example; //  (optional) (default to null)

[apiInstance filebrowserFilesUserpermissionsSearchListWith:id
    id2:id2
    limit:limit
    offset:offset
    username:username
              completionHandler: ^(PaginatedFileBrowserFileUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56, // {Integer} The initial index from which to return the results.
  'username': username_example // {String} 
};

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

namespace Example
{
    public class filebrowserFilesUserpermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var username = username_example;  // String |  (optional)  (default to null)

            try {
                PaginatedFileBrowserFileUserPermissionList result = apiInstance.filebrowserFilesUserpermissionsSearchList(id, id2, limit, offset, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUserpermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.
$username = username_example; // String | 

try {
    $result = $api_instance->filebrowserFilesUserpermissionsSearchList($id, $id2, $limit, $offset, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.
my $username = username_example; # String | 

eval {
    my $result = $api_instance->filebrowserFilesUserpermissionsSearchList(id => $id, id2 => $id2, limit => $limit, offset => $offset, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
username = username_example # String |  (optional) (default to null)

try:
    api_response = api_instance.filebrowser_files_userpermissions_search_list(id, id2=id2, limit=limit, offset=offset, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsSearchList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer
    let username = username_example; // String

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesUserpermissionsSearchList(id, id2, limit, offset, username, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.
username
String

Responses


filebrowserFilesUserpermissionsUpdate

A view for a file's user permission.


/api/v1/filebrowser/files/userpermissions/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/files/userpermissions/{id}/" \
 -d '{
  "permission" : "r",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFileUserPermissionRequest fileBrowserFileUserPermissionRequest = ; // FileBrowserFileUserPermissionRequest | 

        try {
            FileBrowserFileUserPermission result = apiInstance.filebrowserFilesUserpermissionsUpdate(id, fileBrowserFileUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserFilesUserpermissionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserFilesUserpermissionsUpdateWith:id
    fileBrowserFileUserPermissionRequest:fileBrowserFileUserPermissionRequest
              completionHandler: ^(FileBrowserFileUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFileUserPermissionRequest':  // {FileBrowserFileUserPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserFilesUserpermissionsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFileUserPermission result = apiInstance.filebrowserFilesUserpermissionsUpdate(id, fileBrowserFileUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserFilesUserpermissionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserFilesUserpermissionsUpdate($id, $fileBrowserFileUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserFilesUserpermissionsUpdate(id => $id, fileBrowserFileUserPermissionRequest => $fileBrowserFileUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFileUserPermissionRequest =  # FileBrowserFileUserPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_files_userpermissions_update(id, fileBrowserFileUserPermissionRequest=fileBrowserFileUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserFilesUserpermissionsUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserFilesUserpermissionsUpdate(id, fileBrowserFileUserPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFileUserPermissionRequest

Responses


filebrowserGrouppermissionsCreate

A view for a folder's collection of group permissions.


/api/v1/filebrowser/{id}/grouppermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/{id}/grouppermissions/" \
 -d '{
  "grp_name" : "grp_name",
  "permission" : "r"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFolderGroupPermissionRequest fileBrowserFolderGroupPermissionRequest = ; // FileBrowserFolderGroupPermissionRequest | 

        try {
            FileBrowserFolderGroupPermission result = apiInstance.filebrowserGrouppermissionsCreate(id, fileBrowserFolderGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserGrouppermissionsCreateWith:id
    fileBrowserFolderGroupPermissionRequest:fileBrowserFolderGroupPermissionRequest
              completionHandler: ^(FileBrowserFolderGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFolderGroupPermissionRequest':  // {FileBrowserFolderGroupPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserGrouppermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFolderGroupPermission result = apiInstance.filebrowserGrouppermissionsCreate(id, fileBrowserFolderGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserGrouppermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserGrouppermissionsCreate($id, $fileBrowserFolderGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserGrouppermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserGrouppermissionsCreate(id => $id, fileBrowserFolderGroupPermissionRequest => $fileBrowserFolderGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserGrouppermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFolderGroupPermissionRequest =  # FileBrowserFolderGroupPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_grouppermissions_create(id, fileBrowserFolderGroupPermissionRequest=fileBrowserFolderGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserGrouppermissionsCreate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserGrouppermissionsCreate(id, fileBrowserFolderGroupPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFolderGroupPermissionRequest

Responses


filebrowserGrouppermissionsDestroy

A view for a folder's group permission.


/api/v1/filebrowser/grouppermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserGrouppermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserGrouppermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserGrouppermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserGrouppermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserGrouppermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserGrouppermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserGrouppermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserGrouppermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserGrouppermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_grouppermissions_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserGrouppermissionsDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserGrouppermissionsList

A view for a folder's collection of group permissions.


/api/v1/filebrowser/{id}/grouppermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/grouppermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderGroupPermissionList result = apiInstance.filebrowserGrouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderGroupPermissionList result = apiInstance.filebrowserGrouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserGrouppermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFolderGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserGrouppermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderGroupPermissionList result = apiInstance.filebrowserGrouppermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserGrouppermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserGrouppermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserGrouppermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserGrouppermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserGrouppermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_grouppermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserGrouppermissionsList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserGrouppermissionsList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserGrouppermissionsRetrieve

A view for a folder's group permission.


/api/v1/filebrowser/grouppermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserFolderGroupPermission result = apiInstance.filebrowserGrouppermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserGrouppermissionsRetrieveWith:id
              completionHandler: ^(FileBrowserFolderGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserGrouppermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFolderGroupPermission result = apiInstance.filebrowserGrouppermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserGrouppermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserGrouppermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserGrouppermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserGrouppermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserGrouppermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_grouppermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserGrouppermissionsRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserGrouppermissionsSearchList

A view for the collection of folder-specific group permissions resulting from a query search.


/api/v1/filebrowser/{id}/grouppermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/grouppermissions/search/?group_name=groupName_example&id=56&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderGroupPermissionList result = apiInstance.filebrowserGrouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String groupName = new String(); // String | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderGroupPermissionList result = apiInstance.filebrowserGrouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
String *groupName = groupName_example; //  (optional) (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserGrouppermissionsSearchListWith:id
    groupName:groupName
    id2:id2
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFolderGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'groupName': groupName_example, // {String} 
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserGrouppermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var groupName = groupName_example;  // String |  (optional)  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderGroupPermissionList result = apiInstance.filebrowserGrouppermissionsSearchList(id, groupName, id2, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserGrouppermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$groupName = groupName_example; // String | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserGrouppermissionsSearchList($id, $groupName, $id2, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserGrouppermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $groupName = groupName_example; # String | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserGrouppermissionsSearchList(id => $id, groupName => $groupName, id2 => $id2, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserGrouppermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
groupName = groupName_example # String |  (optional) (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_grouppermissions_search_list(id, groupName=groupName, id2=id2, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserGrouppermissionsSearchList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let groupName = groupName_example; // String
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserGrouppermissionsSearchList(id, groupName, id2, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
group_name
String
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserGrouppermissionsUpdate

A view for a folder's group permission.


/api/v1/filebrowser/grouppermissions/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/grouppermissions/{id}/" \
 -d '{
  "grp_name" : "grp_name",
  "permission" : "r"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFolderGroupPermissionRequest fileBrowserFolderGroupPermissionRequest = ; // FileBrowserFolderGroupPermissionRequest | 

        try {
            FileBrowserFolderGroupPermission result = apiInstance.filebrowserGrouppermissionsUpdate(id, fileBrowserFolderGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserGrouppermissionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserGrouppermissionsUpdateWith:id
    fileBrowserFolderGroupPermissionRequest:fileBrowserFolderGroupPermissionRequest
              completionHandler: ^(FileBrowserFolderGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFolderGroupPermissionRequest':  // {FileBrowserFolderGroupPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserGrouppermissionsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFolderGroupPermission result = apiInstance.filebrowserGrouppermissionsUpdate(id, fileBrowserFolderGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserGrouppermissionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserGrouppermissionsUpdate($id, $fileBrowserFolderGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserGrouppermissionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserGrouppermissionsUpdate(id => $id, fileBrowserFolderGroupPermissionRequest => $fileBrowserFolderGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserGrouppermissionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFolderGroupPermissionRequest =  # FileBrowserFolderGroupPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_grouppermissions_update(id, fileBrowserFolderGroupPermissionRequest=fileBrowserFolderGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserGrouppermissionsUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserGrouppermissionsUpdate(id, fileBrowserFolderGroupPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFolderGroupPermissionRequest

Responses


filebrowserLinkfiles.Retrieve

Overriden to be able to make a GET request to an actual file resource.


/api/v1/filebrowser/linkfiles/{id}/.

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
 \
-H "download_token: [[apiKey]]" \
 -H "Accept: */*" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/."
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: DownloadTokenInQueryString
        ApiKeyAuth DownloadTokenInQueryString = (ApiKeyAuth) defaultClient.getAuthentication("DownloadTokenInQueryString");
        DownloadTokenInQueryString.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //DownloadTokenInQueryString.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.filebrowserLinkfiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfiles.Retrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];

// Configure API key authorization: (authentication scheme: DownloadTokenInQueryString)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"download_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"download_token"];


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

[apiInstance filebrowserLinkfiles.RetrieveWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Configure API key authorization: DownloadTokenInQueryString
var DownloadTokenInQueryString = defaultClient.authentications['DownloadTokenInQueryString'];
DownloadTokenInQueryString.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//DownloadTokenInQueryString.apiKeyPrefix['download_token'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = id_example; // {String} 

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

namespace Example
{
    public class filebrowserLinkfiles.RetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: DownloadTokenInQueryString
            Configuration.Default.ApiKey.Add("download_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("download_token", "Bearer");

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

            try {
                File result = apiInstance.filebrowserLinkfiles.Retrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfiles.Retrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Configure API key authorization: DownloadTokenInQueryString
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('download_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('download_token', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfiles.Retrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfiles.Retrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Configure API key authorization: DownloadTokenInQueryString
$WWW::OPenAPIClient::Configuration::api_key->{'download_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'download_token'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfiles.Retrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfiles.Retrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Configure API key authorization: DownloadTokenInQueryString
chris_oag.configuration.api_key['download_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['download_token'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = id_example # String |  (default to null)

try:
    api_response = api_instance.filebrowser_linkfiles/retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfiles.Retrieve: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfiles.Retrieve(id, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses


filebrowserLinkfilesDestroy

A ChRIS link file view.


/api/v1/filebrowser/linkfiles/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserLinkfilesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserLinkfilesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserLinkfilesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserLinkfilesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserLinkfilesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_linkfiles_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserLinkfilesGrouppermissionsCreate

A view for a link file's collection of group permissions.


/api/v1/filebrowser/linkfiles/{id}/grouppermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/grouppermissions/" \
 -d '{
  "grp_name" : "grp_name",
  "permission" : "r"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserLinkFileGroupPermissionRequest fileBrowserLinkFileGroupPermissionRequest = ; // FileBrowserLinkFileGroupPermissionRequest | 

        try {
            FileBrowserLinkFileGroupPermission result = apiInstance.filebrowserLinkfilesGrouppermissionsCreate(id, fileBrowserLinkFileGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesGrouppermissionsCreateWith:id
    fileBrowserLinkFileGroupPermissionRequest:fileBrowserLinkFileGroupPermissionRequest
              completionHandler: ^(FileBrowserLinkFileGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserLinkFileGroupPermissionRequest':  // {FileBrowserLinkFileGroupPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserLinkfilesGrouppermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFileGroupPermission result = apiInstance.filebrowserLinkfilesGrouppermissionsCreate(id, fileBrowserLinkFileGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesGrouppermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesGrouppermissionsCreate($id, $fileBrowserLinkFileGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesGrouppermissionsCreate(id => $id, fileBrowserLinkFileGroupPermissionRequest => $fileBrowserLinkFileGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserLinkFileGroupPermissionRequest =  # FileBrowserLinkFileGroupPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_linkfiles_grouppermissions_create(id, fileBrowserLinkFileGroupPermissionRequest=fileBrowserLinkFileGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsCreate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesGrouppermissionsCreate(id, fileBrowserLinkFileGroupPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserLinkFileGroupPermissionRequest

Responses


filebrowserLinkfilesGrouppermissionsDestroy

A view for a link file's group permission.


/api/v1/filebrowser/linkfiles/grouppermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/linkfiles/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserLinkfilesGrouppermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesGrouppermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserLinkfilesGrouppermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserLinkfilesGrouppermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesGrouppermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserLinkfilesGrouppermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserLinkfilesGrouppermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_linkfiles_grouppermissions_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserLinkfilesGrouppermissionsList

A view for a link file's collection of group permissions.


/api/v1/filebrowser/linkfiles/{id}/grouppermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/grouppermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileGroupPermissionList result = apiInstance.filebrowserLinkfilesGrouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileGroupPermissionList result = apiInstance.filebrowserLinkfilesGrouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserLinkfilesGrouppermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserLinkFileGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserLinkfilesGrouppermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserLinkFileGroupPermissionList result = apiInstance.filebrowserLinkfilesGrouppermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesGrouppermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserLinkfilesGrouppermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserLinkfilesGrouppermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_linkfiles_grouppermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesGrouppermissionsList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserLinkfilesGrouppermissionsRetrieve

A view for a link file's group permission.


/api/v1/filebrowser/linkfiles/grouppermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserLinkFileGroupPermission result = apiInstance.filebrowserLinkfilesGrouppermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesGrouppermissionsRetrieveWith:id
              completionHandler: ^(FileBrowserLinkFileGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserLinkfilesGrouppermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFileGroupPermission result = apiInstance.filebrowserLinkfilesGrouppermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesGrouppermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesGrouppermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesGrouppermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_linkfiles_grouppermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserLinkfilesGrouppermissionsSearchList

A view for the collection of link file-specific group permissions resulting from a query search.


/api/v1/filebrowser/linkfiles/{id}/grouppermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/grouppermissions/search/?group_name=groupName_example&id=56&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileGroupPermissionList result = apiInstance.filebrowserLinkfilesGrouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String groupName = new String(); // String | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileGroupPermissionList result = apiInstance.filebrowserLinkfilesGrouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
String *groupName = groupName_example; //  (optional) (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserLinkfilesGrouppermissionsSearchListWith:id
    groupName:groupName
    id2:id2
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserLinkFileGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'groupName': groupName_example, // {String} 
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserLinkfilesGrouppermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var groupName = groupName_example;  // String |  (optional)  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserLinkFileGroupPermissionList result = apiInstance.filebrowserLinkfilesGrouppermissionsSearchList(id, groupName, id2, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesGrouppermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$groupName = groupName_example; // String | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserLinkfilesGrouppermissionsSearchList($id, $groupName, $id2, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $groupName = groupName_example; # String | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserLinkfilesGrouppermissionsSearchList(id => $id, groupName => $groupName, id2 => $id2, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
groupName = groupName_example # String |  (optional) (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_linkfiles_grouppermissions_search_list(id, groupName=groupName, id2=id2, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsSearchList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let groupName = groupName_example; // String
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesGrouppermissionsSearchList(id, groupName, id2, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
group_name
String
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserLinkfilesGrouppermissionsUpdate

A view for a link file's group permission.


/api/v1/filebrowser/linkfiles/grouppermissions/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/linkfiles/grouppermissions/{id}/" \
 -d '{
  "grp_name" : "grp_name",
  "permission" : "r"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserLinkFileGroupPermissionRequest fileBrowserLinkFileGroupPermissionRequest = ; // FileBrowserLinkFileGroupPermissionRequest | 

        try {
            FileBrowserLinkFileGroupPermission result = apiInstance.filebrowserLinkfilesGrouppermissionsUpdate(id, fileBrowserLinkFileGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesGrouppermissionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesGrouppermissionsUpdateWith:id
    fileBrowserLinkFileGroupPermissionRequest:fileBrowserLinkFileGroupPermissionRequest
              completionHandler: ^(FileBrowserLinkFileGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserLinkFileGroupPermissionRequest':  // {FileBrowserLinkFileGroupPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserLinkfilesGrouppermissionsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFileGroupPermission result = apiInstance.filebrowserLinkfilesGrouppermissionsUpdate(id, fileBrowserLinkFileGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesGrouppermissionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesGrouppermissionsUpdate($id, $fileBrowserLinkFileGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesGrouppermissionsUpdate(id => $id, fileBrowserLinkFileGroupPermissionRequest => $fileBrowserLinkFileGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserLinkFileGroupPermissionRequest =  # FileBrowserLinkFileGroupPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_linkfiles_grouppermissions_update(id, fileBrowserLinkFileGroupPermissionRequest=fileBrowserLinkFileGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesGrouppermissionsUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesGrouppermissionsUpdate(id, fileBrowserLinkFileGroupPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserLinkFileGroupPermissionRequest

Responses


filebrowserLinkfilesList

A view for the collection of all the ChRIS link files directly under this folder.


/api/v1/filebrowser/{id}/linkfiles/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/linkfiles/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileList result = apiInstance.filebrowserLinkfilesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileList result = apiInstance.filebrowserLinkfilesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserLinkfilesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserLinkFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserLinkfilesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserLinkFileList result = apiInstance.filebrowserLinkfilesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserLinkfilesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserLinkfilesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_linkfiles_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserLinkfilesRetrieve

A ChRIS link file view.


/api/v1/filebrowser/linkfiles/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserLinkFile result = apiInstance.filebrowserLinkfilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesRetrieveWith:id
              completionHandler: ^(FileBrowserLinkFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserLinkfilesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFile result = apiInstance.filebrowserLinkfilesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_linkfiles_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserLinkfilesUpdate

A ChRIS link file view.


/api/v1/filebrowser/linkfiles/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/" \
 -d '{
  "new_link_file_path" : "new_link_file_path",
  "path" : "path",
  "fname" : "",
  "public" : true
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserLinkFileRequest fileBrowserLinkFileRequest = ; // FileBrowserLinkFileRequest | 

        try {
            FileBrowserLinkFile result = apiInstance.filebrowserLinkfilesUpdate(id, fileBrowserLinkFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesUpdateWith:id
    fileBrowserLinkFileRequest:fileBrowserLinkFileRequest
              completionHandler: ^(FileBrowserLinkFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserLinkFileRequest':  // {FileBrowserLinkFileRequest} 
};

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

namespace Example
{
    public class filebrowserLinkfilesUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFile result = apiInstance.filebrowserLinkfilesUpdate(id, fileBrowserLinkFileRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesUpdate($id, $fileBrowserLinkFileRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesUpdate(id => $id, fileBrowserLinkFileRequest => $fileBrowserLinkFileRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserLinkFileRequest =  # FileBrowserLinkFileRequest |  (optional)

try:
    api_response = api_instance.filebrowser_linkfiles_update(id, fileBrowserLinkFileRequest=fileBrowserLinkFileRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesUpdate(id, fileBrowserLinkFileRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserLinkFileRequest

Responses


filebrowserLinkfilesUserpermissionsCreate

A view for a link file's collection of user permissions.


/api/v1/filebrowser/linkfiles/{id}/userpermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/userpermissions/" \
 -d '{
  "permission" : "r",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserLinkFileUserPermissionRequest fileBrowserLinkFileUserPermissionRequest = ; // FileBrowserLinkFileUserPermissionRequest | 

        try {
            FileBrowserLinkFileUserPermission result = apiInstance.filebrowserLinkfilesUserpermissionsCreate(id, fileBrowserLinkFileUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesUserpermissionsCreateWith:id
    fileBrowserLinkFileUserPermissionRequest:fileBrowserLinkFileUserPermissionRequest
              completionHandler: ^(FileBrowserLinkFileUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserLinkFileUserPermissionRequest':  // {FileBrowserLinkFileUserPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserLinkfilesUserpermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFileUserPermission result = apiInstance.filebrowserLinkfilesUserpermissionsCreate(id, fileBrowserLinkFileUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUserpermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesUserpermissionsCreate($id, $fileBrowserLinkFileUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesUserpermissionsCreate(id => $id, fileBrowserLinkFileUserPermissionRequest => $fileBrowserLinkFileUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserLinkFileUserPermissionRequest =  # FileBrowserLinkFileUserPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_linkfiles_userpermissions_create(id, fileBrowserLinkFileUserPermissionRequest=fileBrowserLinkFileUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsCreate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesUserpermissionsCreate(id, fileBrowserLinkFileUserPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserLinkFileUserPermissionRequest

Responses


filebrowserLinkfilesUserpermissionsDestroy

A view for a link file's user permission.


/api/v1/filebrowser/linkfiles/userpermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/linkfiles/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            apiInstance.filebrowserLinkfilesUserpermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesUserpermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

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

namespace Example
{
    public class filebrowserLinkfilesUserpermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                apiInstance.filebrowserLinkfilesUserpermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUserpermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $api_instance->filebrowserLinkfilesUserpermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    $api_instance->filebrowserLinkfilesUserpermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_instance.filebrowser_linkfiles_userpermissions_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsDestroy: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserLinkfilesUserpermissionsList

A view for a link file's collection of user permissions.


/api/v1/filebrowser/linkfiles/{id}/userpermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/userpermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileUserPermissionList result = apiInstance.filebrowserLinkfilesUserpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserLinkFileUserPermissionList result = apiInstance.filebrowserLinkfilesUserpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserLinkfilesUserpermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserLinkFileUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserLinkfilesUserpermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserLinkFileUserPermissionList result = apiInstance.filebrowserLinkfilesUserpermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUserpermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserLinkfilesUserpermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserLinkfilesUserpermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_linkfiles_userpermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesUserpermissionsList(id, limit, offset, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserLinkfilesUserpermissionsRetrieve

A view for a link file's user permission.


/api/v1/filebrowser/linkfiles/userpermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserLinkFileUserPermission result = apiInstance.filebrowserLinkfilesUserpermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesUserpermissionsRetrieveWith:id
              completionHandler: ^(FileBrowserLinkFileUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserLinkfilesUserpermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFileUserPermission result = apiInstance.filebrowserLinkfilesUserpermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUserpermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesUserpermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesUserpermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_linkfiles_userpermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserLinkfilesUserpermissionsSearchList

A view for the collection of link file-specific user permissions resulting from a query search.


/api/v1/filebrowser/linkfiles/{id}/userpermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/linkfiles/{id}/userpermissions/search/?id=56&limit=56&offset=56&username=username_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFileBrowserLinkFileUserPermissionList result = apiInstance.filebrowserLinkfilesUserpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String username = new String(); // String | 

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFileBrowserLinkFileUserPermissionList result = apiInstance.filebrowserLinkfilesUserpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *username = username_example; //  (optional) (default to null)

[apiInstance filebrowserLinkfilesUserpermissionsSearchListWith:id
    id2:id2
    limit:limit
    offset:offset
    username:username
              completionHandler: ^(PaginatedFileBrowserLinkFileUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56, // {Integer} The initial index from which to return the results.
  'username': username_example // {String} 
};

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

namespace Example
{
    public class filebrowserLinkfilesUserpermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var username = username_example;  // String |  (optional)  (default to null)

            try {
                PaginatedFileBrowserLinkFileUserPermissionList result = apiInstance.filebrowserLinkfilesUserpermissionsSearchList(id, id2, limit, offset, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUserpermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.
$username = username_example; // String | 

try {
    $result = $api_instance->filebrowserLinkfilesUserpermissionsSearchList($id, $id2, $limit, $offset, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.
my $username = username_example; # String | 

eval {
    my $result = $api_instance->filebrowserLinkfilesUserpermissionsSearchList(id => $id, id2 => $id2, limit => $limit, offset => $offset, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
username = username_example # String |  (optional) (default to null)

try:
    api_response = api_instance.filebrowser_linkfiles_userpermissions_search_list(id, id2=id2, limit=limit, offset=offset, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsSearchList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer
    let username = username_example; // String

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesUserpermissionsSearchList(id, id2, limit, offset, username, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.
username
String

Responses


filebrowserLinkfilesUserpermissionsUpdate

A view for a link file's user permission.


/api/v1/filebrowser/linkfiles/userpermissions/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/linkfiles/userpermissions/{id}/" \
 -d '{
  "permission" : "r",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserLinkFileUserPermissionRequest fileBrowserLinkFileUserPermissionRequest = ; // FileBrowserLinkFileUserPermissionRequest | 

        try {
            FileBrowserLinkFileUserPermission result = apiInstance.filebrowserLinkfilesUserpermissionsUpdate(id, fileBrowserLinkFileUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserLinkfilesUserpermissionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserLinkfilesUserpermissionsUpdateWith:id
    fileBrowserLinkFileUserPermissionRequest:fileBrowserLinkFileUserPermissionRequest
              completionHandler: ^(FileBrowserLinkFileUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserLinkFileUserPermissionRequest':  // {FileBrowserLinkFileUserPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserLinkfilesUserpermissionsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserLinkFileUserPermission result = apiInstance.filebrowserLinkfilesUserpermissionsUpdate(id, fileBrowserLinkFileUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserLinkfilesUserpermissionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserLinkfilesUserpermissionsUpdate($id, $fileBrowserLinkFileUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserLinkfilesUserpermissionsUpdate(id => $id, fileBrowserLinkFileUserPermissionRequest => $fileBrowserLinkFileUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserLinkFileUserPermissionRequest =  # FileBrowserLinkFileUserPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_linkfiles_userpermissions_update(id, fileBrowserLinkFileUserPermissionRequest=fileBrowserLinkFileUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserLinkfilesUserpermissionsUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserLinkfilesUserpermissionsUpdate(id, fileBrowserLinkFileUserPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserLinkFileUserPermissionRequest

Responses


filebrowserList

A view for the initial page of the collection of file browser folders. The returned collection only has a single element.


/api/v1/filebrowser/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderList result = apiInstance.filebrowserList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderList result = apiInstance.filebrowserList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserListWith:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFolderList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderList result = apiInstance.filebrowserList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserList(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserRetrieve

A ChRIS folder view.


/api/v1/filebrowser/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

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

        try {
            FileBrowserFolder result = apiInstance.filebrowserRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserRetrieveWith:id
              completionHandler: ^(FileBrowserFolder output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

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

namespace Example
{
    public class filebrowserRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFolder result = apiInstance.filebrowserRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

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

try:
    api_response = api_instance.filebrowser_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserRetrieve: %s\n" % e)
extern crate FilebrowserApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserSearchList

A view for the collection of file browser folders resulting from a query search. The returned collection only has at most one element.


/api/v1/filebrowser/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/search/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderList result = apiInstance.filebrowserSearchList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderList result = apiInstance.filebrowserSearchList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserSearchListWith:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFolderList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

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

namespace Example
{
    public class filebrowserSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderList result = apiInstance.filebrowserSearchList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserSearchList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserSearchList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_search_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserSearchList: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserSearchList(limit, offset, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserUpdate

A ChRIS folder view.


/api/v1/filebrowser/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/{id}/" \
 -d '{
  "path" : "path",
  "public" : true
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFolderRequest fileBrowserFolderRequest = ; // FileBrowserFolderRequest | 

        try {
            FileBrowserFolder result = apiInstance.filebrowserUpdate(id, fileBrowserFolderRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserUpdateWith:id
    fileBrowserFolderRequest:fileBrowserFolderRequest
              completionHandler: ^(FileBrowserFolder output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFolderRequest':  // {FileBrowserFolderRequest} 
};

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

namespace Example
{
    public class filebrowserUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFolder result = apiInstance.filebrowserUpdate(id, fileBrowserFolderRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserUpdate($id, $fileBrowserFolderRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserUpdate(id => $id, fileBrowserFolderRequest => $fileBrowserFolderRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFolderRequest =  # FileBrowserFolderRequest |  (optional)

try:
    api_response = api_instance.filebrowser_update(id, fileBrowserFolderRequest=fileBrowserFolderRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUpdate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUpdate(id, fileBrowserFolderRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFolderRequest

Responses


filebrowserUserpermissionsCreate

A view for a folder's collection of user permissions.


/api/v1/filebrowser/{id}/userpermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/{id}/userpermissions/" \
 -d '{
  "permission" : "r",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFolderUserPermissionRequest fileBrowserFolderUserPermissionRequest = ; // FileBrowserFolderUserPermissionRequest | 

        try {
            FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsCreate(id, fileBrowserFolderUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


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

[apiInstance filebrowserUserpermissionsCreateWith:id
    fileBrowserFolderUserPermissionRequest:fileBrowserFolderUserPermissionRequest
              completionHandler: ^(FileBrowserFolderUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFolderUserPermissionRequest':  // {FileBrowserFolderUserPermissionRequest} 
};

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

namespace Example
{
    public class filebrowserUserpermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

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

            try {
                FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsCreate(id, fileBrowserFolderUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUserpermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

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

try {
    $result = $api_instance->filebrowserUserpermissionsCreate($id, $fileBrowserFolderUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUserpermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

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

eval {
    my $result = $api_instance->filebrowserUserpermissionsCreate(id => $id, fileBrowserFolderUserPermissionRequest => $fileBrowserFolderUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUserpermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFolderUserPermissionRequest =  # FileBrowserFolderUserPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_userpermissions_create(id, fileBrowserFolderUserPermissionRequest=fileBrowserFolderUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUserpermissionsCreate: %s\n" % e)
extern crate FilebrowserApi;

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

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUserpermissionsCreate(id, fileBrowserFolderUserPermissionRequest, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFolderUserPermissionRequest

Responses


filebrowserUserpermissionsDestroy

A view for a folder's user permission.


/api/v1/filebrowser/userpermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/filebrowser/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

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

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

final api_instance = DefaultApi();

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

try {
    final result = await api_instance.filebrowserUserpermissionsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->filebrowserUserpermissionsDestroy: $e\n');
}

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.filebrowserUserpermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance filebrowserUserpermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.filebrowserUserpermissionsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class filebrowserUserpermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.filebrowserUserpermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUserpermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 

try {
    $api_instance->filebrowserUserpermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUserpermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->filebrowserUserpermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUserpermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.filebrowser_userpermissions_destroy(id)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUserpermissionsDestroy: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUserpermissionsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserUserpermissionsList

A view for a folder's collection of user permissions.


/api/v1/filebrowser/{id}/userpermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/userpermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

import java.io.File;
import java.util.*;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderUserPermissionList result = apiInstance.filebrowserUserpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.filebrowserUserpermissionsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->filebrowserUserpermissionsList: $e\n');
}

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFileBrowserFolderUserPermissionList result = apiInstance.filebrowserUserpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance filebrowserUserpermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFileBrowserFolderUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filebrowserUserpermissionsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class filebrowserUserpermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderUserPermissionList result = apiInstance.filebrowserUserpermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUserpermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->filebrowserUserpermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUserpermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->filebrowserUserpermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUserpermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.filebrowser_userpermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUserpermissionsList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUserpermissionsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


filebrowserUserpermissionsRetrieve

A view for a folder's user permission.


/api/v1/filebrowser/userpermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

import java.io.File;
import java.util.*;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 

        try {
            FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.filebrowserUserpermissionsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->filebrowserUserpermissionsRetrieve: $e\n');
}

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 

        try {
            FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance filebrowserUserpermissionsRetrieveWith:id
              completionHandler: ^(FileBrowserFolderUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
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.filebrowserUserpermissionsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class filebrowserUserpermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)

            try {
                FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUserpermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->filebrowserUserpermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUserpermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->filebrowserUserpermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUserpermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.filebrowser_userpermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUserpermissionsRetrieve: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUserpermissionsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


filebrowserUserpermissionsSearchList

A view for the collection of folder-specific user permissions resulting from a query search.


/api/v1/filebrowser/{id}/userpermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/filebrowser/{id}/userpermissions/search/?id=56&limit=56&offset=56&username=username_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

import java.io.File;
import java.util.*;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFileBrowserFolderUserPermissionList result = apiInstance.filebrowserUserpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String username = new String(); // String | 

try {
    final result = await api_instance.filebrowserUserpermissionsSearchList(id, id2, limit, offset, username);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->filebrowserUserpermissionsSearchList: $e\n');
}

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFileBrowserFolderUserPermissionList result = apiInstance.filebrowserUserpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *username = username_example; //  (optional) (default to null)

[apiInstance filebrowserUserpermissionsSearchListWith:id
    id2:id2
    limit:limit
    offset:offset
    username:username
              completionHandler: ^(PaginatedFileBrowserFolderUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56, // {Integer} The initial index from which to return the results.
  'username': username_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filebrowserUserpermissionsSearchList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class filebrowserUserpermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var username = username_example;  // String |  (optional)  (default to null)

            try {
                PaginatedFileBrowserFolderUserPermissionList result = apiInstance.filebrowserUserpermissionsSearchList(id, id2, limit, offset, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUserpermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.
$username = username_example; // String | 

try {
    $result = $api_instance->filebrowserUserpermissionsSearchList($id, $id2, $limit, $offset, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUserpermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.
my $username = username_example; # String | 

eval {
    my $result = $api_instance->filebrowserUserpermissionsSearchList(id => $id, id2 => $id2, limit => $limit, offset => $offset, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUserpermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
username = username_example # String |  (optional) (default to null)

try:
    api_response = api_instance.filebrowser_userpermissions_search_list(id, id2=id2, limit=limit, offset=offset, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUserpermissionsSearchList: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer
    let username = username_example; // String

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUserpermissionsSearchList(id, id2, limit, offset, username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.
username
String

Responses


filebrowserUserpermissionsUpdate

A view for a folder's user permission.


/api/v1/filebrowser/userpermissions/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/filebrowser/userpermissions/{id}/" \
 -d '{
  "permission" : "r",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilebrowserApi;

import java.io.File;
import java.util.*;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFolderUserPermissionRequest fileBrowserFolderUserPermissionRequest = ; // FileBrowserFolderUserPermissionRequest | 

        try {
            FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsUpdate(id, fileBrowserFolderUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final FileBrowserFolderUserPermissionRequest fileBrowserFolderUserPermissionRequest = new FileBrowserFolderUserPermissionRequest(); // FileBrowserFolderUserPermissionRequest | 

try {
    final result = await api_instance.filebrowserUserpermissionsUpdate(id, fileBrowserFolderUserPermissionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->filebrowserUserpermissionsUpdate: $e\n');
}

import org.openapitools.client.api.FilebrowserApi;

public class FilebrowserApiExample {
    public static void main(String[] args) {
        FilebrowserApi apiInstance = new FilebrowserApi();
        Integer id = 56; // Integer | 
        FileBrowserFolderUserPermissionRequest fileBrowserFolderUserPermissionRequest = ; // FileBrowserFolderUserPermissionRequest | 

        try {
            FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsUpdate(id, fileBrowserFolderUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilebrowserApi#filebrowserUserpermissionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
FilebrowserApi *apiInstance = [[FilebrowserApi alloc] init];
Integer *id = 56; //  (default to null)
FileBrowserFolderUserPermissionRequest *fileBrowserFolderUserPermissionRequest = ; //  (optional)

[apiInstance filebrowserUserpermissionsUpdateWith:id
    fileBrowserFolderUserPermissionRequest:fileBrowserFolderUserPermissionRequest
              completionHandler: ^(FileBrowserFolderUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.FilebrowserApi()
var id = 56; // {Integer} 
var opts = {
  'fileBrowserFolderUserPermissionRequest':  // {FileBrowserFolderUserPermissionRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filebrowserUserpermissionsUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class filebrowserUserpermissionsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new FilebrowserApi();
            var id = 56;  // Integer |  (default to null)
            var fileBrowserFolderUserPermissionRequest = new FileBrowserFolderUserPermissionRequest(); // FileBrowserFolderUserPermissionRequest |  (optional) 

            try {
                FileBrowserFolderUserPermission result = apiInstance.filebrowserUserpermissionsUpdate(id, fileBrowserFolderUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilebrowserApi.filebrowserUserpermissionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilebrowserApi();
$id = 56; // Integer | 
$fileBrowserFolderUserPermissionRequest = ; // FileBrowserFolderUserPermissionRequest | 

try {
    $result = $api_instance->filebrowserUserpermissionsUpdate($id, $fileBrowserFolderUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilebrowserApi->filebrowserUserpermissionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilebrowserApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilebrowserApi->new();
my $id = 56; # Integer | 
my $fileBrowserFolderUserPermissionRequest = WWW::OPenAPIClient::Object::FileBrowserFolderUserPermissionRequest->new(); # FileBrowserFolderUserPermissionRequest | 

eval {
    my $result = $api_instance->filebrowserUserpermissionsUpdate(id => $id, fileBrowserFolderUserPermissionRequest => $fileBrowserFolderUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilebrowserApi->filebrowserUserpermissionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.FilebrowserApi()
id = 56 # Integer |  (default to null)
fileBrowserFolderUserPermissionRequest =  # FileBrowserFolderUserPermissionRequest |  (optional)

try:
    api_response = api_instance.filebrowser_userpermissions_update(id, fileBrowserFolderUserPermissionRequest=fileBrowserFolderUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilebrowserApi->filebrowserUserpermissionsUpdate: %s\n" % e)
extern crate FilebrowserApi;

pub fn main() {
    let id = 56; // Integer
    let fileBrowserFolderUserPermissionRequest = ; // FileBrowserFolderUserPermissionRequest

    let mut context = FilebrowserApi::Context::default();
    let result = client.filebrowserUserpermissionsUpdate(id, fileBrowserFolderUserPermissionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
fileBrowserFolderUserPermissionRequest

Responses


Grouppermissions

grouppermissionsCreate

A view for a feed's collection of group permissions.


/api/v1/{id}/grouppermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/{id}/grouppermissions/" \
 -d '{
  "grp_name" : "grp_name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GrouppermissionsApi;

import java.io.File;
import java.util.*;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 
        FeedGroupPermissionRequest feedGroupPermissionRequest = ; // FeedGroupPermissionRequest | 

        try {
            FeedGroupPermission result = apiInstance.grouppermissionsCreate(id, feedGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final FeedGroupPermissionRequest feedGroupPermissionRequest = new FeedGroupPermissionRequest(); // FeedGroupPermissionRequest | 

try {
    final result = await api_instance.grouppermissionsCreate(id, feedGroupPermissionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->grouppermissionsCreate: $e\n');
}

import org.openapitools.client.api.GrouppermissionsApi;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 
        FeedGroupPermissionRequest feedGroupPermissionRequest = ; // FeedGroupPermissionRequest | 

        try {
            FeedGroupPermission result = apiInstance.grouppermissionsCreate(id, feedGroupPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GrouppermissionsApi *apiInstance = [[GrouppermissionsApi alloc] init];
Integer *id = 56; //  (default to null)
FeedGroupPermissionRequest *feedGroupPermissionRequest = ; // 

[apiInstance grouppermissionsCreateWith:id
    feedGroupPermissionRequest:feedGroupPermissionRequest
              completionHandler: ^(FeedGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GrouppermissionsApi()
var id = 56; // {Integer} 
var feedGroupPermissionRequest = ; // {FeedGroupPermissionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.grouppermissionsCreate(id, feedGroupPermissionRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class grouppermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GrouppermissionsApi();
            var id = 56;  // Integer |  (default to null)
            var feedGroupPermissionRequest = new FeedGroupPermissionRequest(); // FeedGroupPermissionRequest | 

            try {
                FeedGroupPermission result = apiInstance.grouppermissionsCreate(id, feedGroupPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GrouppermissionsApi.grouppermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GrouppermissionsApi();
$id = 56; // Integer | 
$feedGroupPermissionRequest = ; // FeedGroupPermissionRequest | 

try {
    $result = $api_instance->grouppermissionsCreate($id, $feedGroupPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GrouppermissionsApi->grouppermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GrouppermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GrouppermissionsApi->new();
my $id = 56; # Integer | 
my $feedGroupPermissionRequest = WWW::OPenAPIClient::Object::FeedGroupPermissionRequest->new(); # FeedGroupPermissionRequest | 

eval {
    my $result = $api_instance->grouppermissionsCreate(id => $id, feedGroupPermissionRequest => $feedGroupPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GrouppermissionsApi->grouppermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GrouppermissionsApi()
id = 56 # Integer |  (default to null)
feedGroupPermissionRequest =  # FeedGroupPermissionRequest | 

try:
    api_response = api_instance.grouppermissions_create(id, feedGroupPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GrouppermissionsApi->grouppermissionsCreate: %s\n" % e)
extern crate GrouppermissionsApi;

pub fn main() {
    let id = 56; // Integer
    let feedGroupPermissionRequest = ; // FeedGroupPermissionRequest

    let mut context = GrouppermissionsApi::Context::default();
    let result = client.grouppermissionsCreate(id, feedGroupPermissionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
feedGroupPermissionRequest *

Responses


grouppermissionsDestroy

A view for a feed's group permission.


/api/v1/grouppermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GrouppermissionsApi;

import java.io.File;
import java.util.*;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.grouppermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.grouppermissionsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->grouppermissionsDestroy: $e\n');
}

import org.openapitools.client.api.GrouppermissionsApi;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.grouppermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GrouppermissionsApi *apiInstance = [[GrouppermissionsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance grouppermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GrouppermissionsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.grouppermissionsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class grouppermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GrouppermissionsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.grouppermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling GrouppermissionsApi.grouppermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GrouppermissionsApi();
$id = 56; // Integer | 

try {
    $api_instance->grouppermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling GrouppermissionsApi->grouppermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GrouppermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GrouppermissionsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->grouppermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling GrouppermissionsApi->grouppermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GrouppermissionsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.grouppermissions_destroy(id)
except ApiException as e:
    print("Exception when calling GrouppermissionsApi->grouppermissionsDestroy: %s\n" % e)
extern crate GrouppermissionsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = GrouppermissionsApi::Context::default();
    let result = client.grouppermissionsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


grouppermissionsList

A view for a feed's collection of group permissions.


/api/v1/{id}/grouppermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/grouppermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GrouppermissionsApi;

import java.io.File;
import java.util.*;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedGroupPermissionList result = apiInstance.grouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.grouppermissionsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->grouppermissionsList: $e\n');
}

import org.openapitools.client.api.GrouppermissionsApi;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedGroupPermissionList result = apiInstance.grouppermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GrouppermissionsApi *apiInstance = [[GrouppermissionsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance grouppermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFeedGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GrouppermissionsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.grouppermissionsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class grouppermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GrouppermissionsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedGroupPermissionList result = apiInstance.grouppermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GrouppermissionsApi.grouppermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GrouppermissionsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->grouppermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GrouppermissionsApi->grouppermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GrouppermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GrouppermissionsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->grouppermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GrouppermissionsApi->grouppermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GrouppermissionsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.grouppermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GrouppermissionsApi->grouppermissionsList: %s\n" % e)
extern crate GrouppermissionsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = GrouppermissionsApi::Context::default();
    let result = client.grouppermissionsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


grouppermissionsRetrieve

A view for a feed's group permission.


/api/v1/grouppermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/grouppermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GrouppermissionsApi;

import java.io.File;
import java.util.*;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 

        try {
            FeedGroupPermission result = apiInstance.grouppermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.grouppermissionsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->grouppermissionsRetrieve: $e\n');
}

import org.openapitools.client.api.GrouppermissionsApi;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 

        try {
            FeedGroupPermission result = apiInstance.grouppermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GrouppermissionsApi *apiInstance = [[GrouppermissionsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance grouppermissionsRetrieveWith:id
              completionHandler: ^(FeedGroupPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GrouppermissionsApi()
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.grouppermissionsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class grouppermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GrouppermissionsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                FeedGroupPermission result = apiInstance.grouppermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GrouppermissionsApi.grouppermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GrouppermissionsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->grouppermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GrouppermissionsApi->grouppermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GrouppermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GrouppermissionsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->grouppermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GrouppermissionsApi->grouppermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GrouppermissionsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.grouppermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GrouppermissionsApi->grouppermissionsRetrieve: %s\n" % e)
extern crate GrouppermissionsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = GrouppermissionsApi::Context::default();
    let result = client.grouppermissionsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


grouppermissionsSearchList

A view for the collection of feed-specific group permissions resulting from a query search.


/api/v1/{id}/grouppermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/grouppermissions/search/?group_name=groupName_example&id=56&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GrouppermissionsApi;

import java.io.File;
import java.util.*;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedGroupPermissionList result = apiInstance.grouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String groupName = new String(); // String | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.grouppermissionsSearchList(id, groupName, id2, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->grouppermissionsSearchList: $e\n');
}

import org.openapitools.client.api.GrouppermissionsApi;

public class GrouppermissionsApiExample {
    public static void main(String[] args) {
        GrouppermissionsApi apiInstance = new GrouppermissionsApi();
        Integer id = 56; // Integer | 
        String groupName = groupName_example; // String | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedGroupPermissionList result = apiInstance.grouppermissionsSearchList(id, groupName, id2, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GrouppermissionsApi#grouppermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GrouppermissionsApi *apiInstance = [[GrouppermissionsApi alloc] init];
Integer *id = 56; //  (default to null)
String *groupName = groupName_example; //  (optional) (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance grouppermissionsSearchListWith:id
    groupName:groupName
    id2:id2
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFeedGroupPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GrouppermissionsApi()
var id = 56; // {Integer} 
var opts = {
  'groupName': groupName_example, // {String} 
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.grouppermissionsSearchList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class grouppermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GrouppermissionsApi();
            var id = 56;  // Integer |  (default to null)
            var groupName = groupName_example;  // String |  (optional)  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedGroupPermissionList result = apiInstance.grouppermissionsSearchList(id, groupName, id2, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GrouppermissionsApi.grouppermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GrouppermissionsApi();
$id = 56; // Integer | 
$groupName = groupName_example; // String | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->grouppermissionsSearchList($id, $groupName, $id2, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GrouppermissionsApi->grouppermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GrouppermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GrouppermissionsApi->new();
my $id = 56; # Integer | 
my $groupName = groupName_example; # String | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->grouppermissionsSearchList(id => $id, groupName => $groupName, id2 => $id2, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GrouppermissionsApi->grouppermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GrouppermissionsApi()
id = 56 # Integer |  (default to null)
groupName = groupName_example # String |  (optional) (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.grouppermissions_search_list(id, groupName=groupName, id2=id2, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GrouppermissionsApi->grouppermissionsSearchList: %s\n" % e)
extern crate GrouppermissionsApi;

pub fn main() {
    let id = 56; // Integer
    let groupName = groupName_example; // String
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = GrouppermissionsApi::Context::default();
    let result = client.grouppermissionsSearchList(id, groupName, id2, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
group_name
String
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


Groups

groupsCreate

A view for the collection of groups that can be used by ChRIS admins to add a new group through a REST API (alternative to the HTML-based admin site).


/api/v1/groups/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/groups/" \
 -d '{
  "name" : "name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        GroupRequest groupRequest = ; // GroupRequest | 

        try {
            Group result = apiInstance.groupsCreate(groupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GroupRequest groupRequest = new GroupRequest(); // GroupRequest | 

try {
    final result = await api_instance.groupsCreate(groupRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsCreate: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        GroupRequest groupRequest = ; // GroupRequest | 

        try {
            Group result = apiInstance.groupsCreate(groupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
GroupRequest *groupRequest = ; // 

[apiInstance groupsCreateWith:groupRequest
              completionHandler: ^(Group output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var groupRequest = ; // {GroupRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsCreate(groupRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var groupRequest = new GroupRequest(); // GroupRequest | 

            try {
                Group result = apiInstance.groupsCreate(groupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$groupRequest = ; // GroupRequest | 

try {
    $result = $api_instance->groupsCreate($groupRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $groupRequest = WWW::OPenAPIClient::Object::GroupRequest->new(); # GroupRequest | 

eval {
    my $result = $api_instance->groupsCreate(groupRequest => $groupRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
groupRequest =  # GroupRequest | 

try:
    api_response = api_instance.groups_create(groupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsCreate: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let groupRequest = ; // GroupRequest

    let mut context = GroupsApi::Context::default();
    let result = client.groupsCreate(groupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
groupRequest *

Responses


groupsDestroy

A view for a group that can be used by ChRIS admins to delete the group through a REST API.


/api/v1/groups/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/groups/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.groupsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.groupsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsDestroy: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.groupsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance groupsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.groupsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.groupsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 

try {
    $api_instance->groupsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->groupsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.groups_destroy(id)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsDestroy: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


groupsList

A view for the collection of groups that can be used by ChRIS admins to add a new group through a REST API (alternative to the HTML-based admin site).


/api/v1/groups/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/groups/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupList result = apiInstance.groupsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.groupsList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsList: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupList result = apiInstance.groupsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance groupsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedGroupList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedGroupList result = apiInstance.groupsList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->groupsList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->groupsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.groups_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsList: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


groupsRetrieve

A view for a group that can be used by ChRIS admins to delete the group through a REST API.


/api/v1/groups/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/groups/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            Group result = apiInstance.groupsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.groupsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsRetrieve: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            Group result = apiInstance.groupsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance groupsRetrieveWith:id
              completionHandler: ^(Group output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
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.groupsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Group result = apiInstance.groupsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->groupsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->groupsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.groups_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsRetrieve: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


groupsSearchList

A view for the collection of groups resulting from a query search.


/api/v1/groups/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/groups/search/?id=56&limit=56&name=name_example&name_icontains=nameIcontains_example&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        String name = name_example; // String | 
        String nameIcontains = nameIcontains_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupList result = apiInstance.groupsSearchList(id, limit, name, nameIcontains, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final String name = new String(); // String | 
final String nameIcontains = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.groupsSearchList(id, limit, name, nameIcontains, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsSearchList: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        String name = name_example; // String | 
        String nameIcontains = nameIcontains_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupList result = apiInstance.groupsSearchList(id, limit, name, nameIcontains, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
String *nameIcontains = nameIcontains_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance groupsSearchListWith:id
    limit:limit
    name:name
    nameIcontains:nameIcontains
    offset:offset
              completionHandler: ^(PaginatedGroupList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var opts = {
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'name': name_example, // {String} 
  'nameIcontains': nameIcontains_example, // {String} 
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var nameIcontains = nameIcontains_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedGroupList result = apiInstance.groupsSearchList(id, limit, name, nameIcontains, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$name = name_example; // String | 
$nameIcontains = nameIcontains_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->groupsSearchList($id, $limit, $name, $nameIcontains, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $name = name_example; # String | 
my $nameIcontains = nameIcontains_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->groupsSearchList(id => $id, limit => $limit, name => $name, nameIcontains => $nameIcontains, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
name = name_example # String |  (optional) (default to null)
nameIcontains = nameIcontains_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.groups_search_list(id=id, limit=limit, name=name, nameIcontains=nameIcontains, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsSearchList: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let name = name_example; // String
    let nameIcontains = nameIcontains_example; // String
    let offset = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsSearchList(id, limit, name, nameIcontains, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
name
String
name_icontains
String
offset
Integer
The initial index from which to return the results.

Responses


groupsUsersCreate

A view for a group-specific collection of group users.


/api/v1/groups/{id}/users/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/groups/{id}/users/" \
 -d '{
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        GroupUserRequest groupUserRequest = ; // GroupUserRequest | 

        try {
            GroupUser result = apiInstance.groupsUsersCreate(id, groupUserRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final GroupUserRequest groupUserRequest = new GroupUserRequest(); // GroupUserRequest | 

try {
    final result = await api_instance.groupsUsersCreate(id, groupUserRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsUsersCreate: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        GroupUserRequest groupUserRequest = ; // GroupUserRequest | 

        try {
            GroupUser result = apiInstance.groupsUsersCreate(id, groupUserRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)
GroupUserRequest *groupUserRequest = ; // 

[apiInstance groupsUsersCreateWith:id
    groupUserRequest:groupUserRequest
              completionHandler: ^(GroupUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var id = 56; // {Integer} 
var groupUserRequest = ; // {GroupUserRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsUsersCreate(id, groupUserRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsUsersCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)
            var groupUserRequest = new GroupUserRequest(); // GroupUserRequest | 

            try {
                GroupUser result = apiInstance.groupsUsersCreate(id, groupUserRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsUsersCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 
$groupUserRequest = ; // GroupUserRequest | 

try {
    $result = $api_instance->groupsUsersCreate($id, $groupUserRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsUsersCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 
my $groupUserRequest = WWW::OPenAPIClient::Object::GroupUserRequest->new(); # GroupUserRequest | 

eval {
    my $result = $api_instance->groupsUsersCreate(id => $id, groupUserRequest => $groupUserRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsUsersCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)
groupUserRequest =  # GroupUserRequest | 

try:
    api_response = api_instance.groups_users_create(id, groupUserRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsUsersCreate: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer
    let groupUserRequest = ; // GroupUserRequest

    let mut context = GroupsApi::Context::default();
    let result = client.groupsUsersCreate(id, groupUserRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
groupUserRequest *

Responses


groupsUsersDestroy

A view for a group-user relationship that can be used by ChRIS admins to delete a user from a group through a REST API.


/api/v1/groups/users/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/groups/users/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.groupsUsersDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.groupsUsersDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsUsersDestroy: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.groupsUsersDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance groupsUsersDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.groupsUsersDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsUsersDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.groupsUsersDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsUsersDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 

try {
    $api_instance->groupsUsersDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsUsersDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->groupsUsersDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsUsersDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.groups_users_destroy(id)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsUsersDestroy: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsUsersDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


groupsUsersList

A view for a group-specific collection of group users.


/api/v1/groups/{id}/users/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/groups/{id}/users/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupUserList result = apiInstance.groupsUsersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.groupsUsersList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsUsersList: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupUserList result = apiInstance.groupsUsersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance groupsUsersListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedGroupUserList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsUsersList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsUsersListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedGroupUserList result = apiInstance.groupsUsersList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsUsersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->groupsUsersList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsUsersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->groupsUsersList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsUsersList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.groups_users_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsUsersList: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsUsersList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


groupsUsersRetrieve

A view for a group-user relationship that can be used by ChRIS admins to delete a user from a group through a REST API.


/api/v1/groups/users/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/groups/users/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            GroupUser result = apiInstance.groupsUsersRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.groupsUsersRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsUsersRetrieve: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 

        try {
            GroupUser result = apiInstance.groupsUsersRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance groupsUsersRetrieveWith:id
              completionHandler: ^(GroupUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
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.groupsUsersRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsUsersRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                GroupUser result = apiInstance.groupsUsersRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsUsersRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->groupsUsersRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsUsersRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->groupsUsersRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsUsersRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.groups_users_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsUsersRetrieve: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.groupsUsersRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


groupsUsersSearchList

A view for the collection of group users resulting from a query search.


/api/v1/groups/{id}/users/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/groups/{id}/users/search/?id=56&limit=56&offset=56&username=username_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedGroupUserList result = apiInstance.groupsUsersSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String username = new String(); // String | 

try {
    final result = await api_instance.groupsUsersSearchList(id, id2, limit, offset, username);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->groupsUsersSearchList: $e\n');
}

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedGroupUserList result = apiInstance.groupsUsersSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupsUsersSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *username = username_example; //  (optional) (default to null)

[apiInstance groupsUsersSearchListWith:id
    id2:id2
    limit:limit
    offset:offset
    username:username
              completionHandler: ^(PaginatedGroupUserList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.GroupsApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56, // {Integer} The initial index from which to return the results.
  'username': username_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.groupsUsersSearchList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class groupsUsersSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var username = username_example;  // String |  (optional)  (default to null)

            try {
                PaginatedGroupUserList result = apiInstance.groupsUsersSearchList(id, id2, limit, offset, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.groupsUsersSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.
$username = username_example; // String | 

try {
    $result = $api_instance->groupsUsersSearchList($id, $id2, $limit, $offset, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupsUsersSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.
my $username = username_example; # String | 

eval {
    my $result = $api_instance->groupsUsersSearchList(id => $id, id2 => $id2, limit => $limit, offset => $offset, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupsUsersSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.GroupsApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
username = username_example # String |  (optional) (default to null)

try:
    api_response = api_instance.groups_users_search_list(id, id2=id2, limit=limit, offset=offset, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupsUsersSearchList: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let id = 56; // Integer
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer
    let username = username_example; // String

    let mut context = GroupsApi::Context::default();
    let result = client.groupsUsersSearchList(id, id2, limit, offset, username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.
username
String

Responses


Note

noteRetrieve

A note view.


/api/v1/note{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/note{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NoteApi;

import java.io.File;
import java.util.*;

public class NoteApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NoteApi apiInstance = new NoteApi();
        Integer id = 56; // Integer | 

        try {
            Note result = apiInstance.noteRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NoteApi#noteRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.noteRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->noteRetrieve: $e\n');
}

import org.openapitools.client.api.NoteApi;

public class NoteApiExample {
    public static void main(String[] args) {
        NoteApi apiInstance = new NoteApi();
        Integer id = 56; // Integer | 

        try {
            Note result = apiInstance.noteRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NoteApi#noteRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
NoteApi *apiInstance = [[NoteApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance noteRetrieveWith:id
              completionHandler: ^(Note output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.NoteApi()
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.noteRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class noteRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new NoteApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Note result = apiInstance.noteRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NoteApi.noteRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NoteApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->noteRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NoteApi->noteRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NoteApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NoteApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->noteRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NoteApi->noteRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.NoteApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.note_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NoteApi->noteRetrieve: %s\n" % e)
extern crate NoteApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = NoteApi::Context::default();
    let result = client.noteRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


noteUpdate

A note view.


/api/v1/note{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/note{id}/" \
 -d '{
  "title" : "title",
  "content" : "content"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NoteApi;

import java.io.File;
import java.util.*;

public class NoteApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NoteApi apiInstance = new NoteApi();
        Integer id = 56; // Integer | 
        NoteRequest noteRequest = ; // NoteRequest | 

        try {
            Note result = apiInstance.noteUpdate(id, noteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NoteApi#noteUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final NoteRequest noteRequest = new NoteRequest(); // NoteRequest | 

try {
    final result = await api_instance.noteUpdate(id, noteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->noteUpdate: $e\n');
}

import org.openapitools.client.api.NoteApi;

public class NoteApiExample {
    public static void main(String[] args) {
        NoteApi apiInstance = new NoteApi();
        Integer id = 56; // Integer | 
        NoteRequest noteRequest = ; // NoteRequest | 

        try {
            Note result = apiInstance.noteUpdate(id, noteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NoteApi#noteUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
NoteApi *apiInstance = [[NoteApi alloc] init];
Integer *id = 56; //  (default to null)
NoteRequest *noteRequest = ; //  (optional)

[apiInstance noteUpdateWith:id
    noteRequest:noteRequest
              completionHandler: ^(Note output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.NoteApi()
var id = 56; // {Integer} 
var opts = {
  'noteRequest':  // {NoteRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.noteUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class noteUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new NoteApi();
            var id = 56;  // Integer |  (default to null)
            var noteRequest = new NoteRequest(); // NoteRequest |  (optional) 

            try {
                Note result = apiInstance.noteUpdate(id, noteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NoteApi.noteUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NoteApi();
$id = 56; // Integer | 
$noteRequest = ; // NoteRequest | 

try {
    $result = $api_instance->noteUpdate($id, $noteRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NoteApi->noteUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NoteApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NoteApi->new();
my $id = 56; # Integer | 
my $noteRequest = WWW::OPenAPIClient::Object::NoteRequest->new(); # NoteRequest | 

eval {
    my $result = $api_instance->noteUpdate(id => $id, noteRequest => $noteRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NoteApi->noteUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.NoteApi()
id = 56 # Integer |  (default to null)
noteRequest =  # NoteRequest |  (optional)

try:
    api_response = api_instance.note_update(id, noteRequest=noteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NoteApi->noteUpdate: %s\n" % e)
extern crate NoteApi;

pub fn main() {
    let id = 56; // Integer
    let noteRequest = ; // NoteRequest

    let mut context = NoteApi::Context::default();
    let result = client.noteUpdate(id, noteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
noteRequest

Responses


Pacs

pacsFiles.Retrieve

Overriden to be able to make a GET request to an actual file resource.


/api/v1/pacs/files/{id}/.

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
 \
-H "download_token: [[apiKey]]" \
 -H "Accept: */*" \
 "http://localhost/api/v1/pacs/files/{id}/."
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: DownloadTokenInQueryString
        ApiKeyAuth DownloadTokenInQueryString = (ApiKeyAuth) defaultClient.getAuthentication("DownloadTokenInQueryString");
        DownloadTokenInQueryString.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //DownloadTokenInQueryString.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.pacsFiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFiles.Retrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 

try {
    final result = await api_instance.pacsFiles.Retrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsFiles.Retrieve: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.pacsFiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFiles.Retrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];

// Configure API key authorization: (authentication scheme: DownloadTokenInQueryString)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"download_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"download_token"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
String *id = id_example; //  (default to null)

[apiInstance pacsFiles.RetrieveWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Configure API key authorization: DownloadTokenInQueryString
var DownloadTokenInQueryString = defaultClient.authentications['DownloadTokenInQueryString'];
DownloadTokenInQueryString.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//DownloadTokenInQueryString.apiKeyPrefix['download_token'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = id_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsFiles.Retrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsFiles.RetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: DownloadTokenInQueryString
            Configuration.Default.ApiKey.Add("download_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("download_token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = id_example;  // String |  (default to null)

            try {
                File result = apiInstance.pacsFiles.Retrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsFiles.Retrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Configure API key authorization: DownloadTokenInQueryString
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('download_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('download_token', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = id_example; // String | 

try {
    $result = $api_instance->pacsFiles.Retrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsFiles.Retrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Configure API key authorization: DownloadTokenInQueryString
$WWW::OPenAPIClient::Configuration::api_key->{'download_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'download_token'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = id_example; # String | 

eval {
    my $result = $api_instance->pacsFiles.Retrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsFiles.Retrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Configure API key authorization: DownloadTokenInQueryString
chris_oag.configuration.api_key['download_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['download_token'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = id_example # String |  (default to null)

try:
    api_response = api_instance.pacs_files/retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsFiles.Retrieve: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = id_example; // String

    let mut context = PacsApi::Context::default();
    let result = client.pacsFiles.Retrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses


pacsFilesList

A view for the collection of PACS files.


/api/v1/pacs/files/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/files/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSFileList result = apiInstance.pacsFilesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFilesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsFilesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsFilesList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSFileList result = apiInstance.pacsFilesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsFilesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPACSFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsFilesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsFilesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSFileList result = apiInstance.pacsFilesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsFilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsFilesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsFilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsFilesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsFilesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_files_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsFilesList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsFilesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsFilesRetrieve

A PACS file view.


/api/v1/pacs/files/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/files/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSFile result = apiInstance.pacsFilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFilesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsFilesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsFilesRetrieve: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSFile result = apiInstance.pacsFilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFilesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsFilesRetrieveWith:id
              completionHandler: ^(PACSFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
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.pacsFilesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsFilesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PACSFile result = apiInstance.pacsFilesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsFilesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pacsFilesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsFilesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pacsFilesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsFilesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pacs_files_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsFilesRetrieve: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsFilesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsFilesSearchList

A view for the collection of PACS files resulting from a query search.


/api/v1/pacs/files/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/files/search/?fname=fname_example&fname_exact=fnameExact_example&fname_icontains=fnameIcontains_example&fname_icontains_topdir_unique=fnameIcontainsTopdirUnique_example&fname_nslashes=fnameNslashes_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        String fname = fname_example; // String | 
        String fnameExact = fnameExact_example; // String | 
        String fnameIcontains = fnameIcontains_example; // String | 
        String fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example; // String | 
        String fnameNslashes = fnameNslashes_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSFileList result = apiInstance.pacsFilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsTopdirUnique, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFilesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String fname = new String(); // String | 
final String fnameExact = new String(); // String | 
final String fnameIcontains = new String(); // String | 
final String fnameIcontainsTopdirUnique = new String(); // String | 
final String fnameNslashes = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsFilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsTopdirUnique, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsFilesSearchList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        String fname = fname_example; // String | 
        String fnameExact = fnameExact_example; // String | 
        String fnameIcontains = fnameIcontains_example; // String | 
        String fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example; // String | 
        String fnameNslashes = fnameNslashes_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSFileList result = apiInstance.pacsFilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsTopdirUnique, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsFilesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
String *fname = fname_example; //  (optional) (default to null)
String *fnameExact = fnameExact_example; //  (optional) (default to null)
String *fnameIcontains = fnameIcontains_example; //  (optional) (default to null)
String *fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example; //  (optional) (default to null)
String *fnameNslashes = fnameNslashes_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsFilesSearchListWith:fname
    fnameExact:fnameExact
    fnameIcontains:fnameIcontains
    fnameIcontainsTopdirUnique:fnameIcontainsTopdirUnique
    fnameNslashes:fnameNslashes
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    offset:offset
              completionHandler: ^(PaginatedPACSFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'fname': fname_example, // {String} 
  'fnameExact': fnameExact_example, // {String} 
  'fnameIcontains': fnameIcontains_example, // {String} 
  'fnameIcontainsTopdirUnique': fnameIcontainsTopdirUnique_example, // {String} 
  'fnameNslashes': fnameNslashes_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsFilesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsFilesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var fname = fname_example;  // String |  (optional)  (default to null)
            var fnameExact = fnameExact_example;  // String |  (optional)  (default to null)
            var fnameIcontains = fnameIcontains_example;  // String |  (optional)  (default to null)
            var fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example;  // String |  (optional)  (default to null)
            var fnameNslashes = fnameNslashes_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSFileList result = apiInstance.pacsFilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsTopdirUnique, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsFilesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$fname = fname_example; // String | 
$fnameExact = fnameExact_example; // String | 
$fnameIcontains = fnameIcontains_example; // String | 
$fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example; // String | 
$fnameNslashes = fnameNslashes_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsFilesSearchList($fname, $fnameExact, $fnameIcontains, $fnameIcontainsTopdirUnique, $fnameNslashes, $id, $limit, $maxCreationDate, $minCreationDate, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsFilesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $fname = fname_example; # String | 
my $fnameExact = fnameExact_example; # String | 
my $fnameIcontains = fnameIcontains_example; # String | 
my $fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example; # String | 
my $fnameNslashes = fnameNslashes_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsFilesSearchList(fname => $fname, fnameExact => $fnameExact, fnameIcontains => $fnameIcontains, fnameIcontainsTopdirUnique => $fnameIcontainsTopdirUnique, fnameNslashes => $fnameNslashes, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsFilesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
fname = fname_example # String |  (optional) (default to null)
fnameExact = fnameExact_example # String |  (optional) (default to null)
fnameIcontains = fnameIcontains_example # String |  (optional) (default to null)
fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example # String |  (optional) (default to null)
fnameNslashes = fnameNslashes_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_files_search_list(fname=fname, fnameExact=fnameExact, fnameIcontains=fnameIcontains, fnameIcontainsTopdirUnique=fnameIcontainsTopdirUnique, fnameNslashes=fnameNslashes, id=id, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsFilesSearchList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let fname = fname_example; // String
    let fnameExact = fnameExact_example; // String
    let fnameIcontains = fnameIcontains_example; // String
    let fnameIcontainsTopdirUnique = fnameIcontainsTopdirUnique_example; // String
    let fnameNslashes = fnameNslashes_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsFilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsTopdirUnique, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
fname
String
fname_exact
String
fname_icontains
String
fname_icontains_topdir_unique
String
fname_nslashes
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
offset
Integer
The initial index from which to return the results.

Responses


pacsList

A view for the collection of registered PACS.


/api/v1/pacs/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSList result = apiInstance.pacsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSList result = apiInstance.pacsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPACSList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSList result = apiInstance.pacsList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsQueriesCreate

A view for the collection of PACS-specific queries.


/api/v1/pacs/{id}/queries/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pacs/{id}/queries/" \
 -d '{
  "query" : "",
  "description" : "description",
  "title" : "title"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        PACSQueryRequest pACSQueryRequest = ; // PACSQueryRequest | 

        try {
            PACSQuery result = apiInstance.pacsQueriesCreate(id, pACSQueryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final PACSQueryRequest pACSQueryRequest = new PACSQueryRequest(); // PACSQueryRequest | 

try {
    final result = await api_instance.pacsQueriesCreate(id, pACSQueryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesCreate: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        PACSQueryRequest pACSQueryRequest = ; // PACSQueryRequest | 

        try {
            PACSQuery result = apiInstance.pacsQueriesCreate(id, pACSQueryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)
PACSQueryRequest *pACSQueryRequest = ; // 

[apiInstance pacsQueriesCreateWith:id
    pACSQueryRequest:pACSQueryRequest
              completionHandler: ^(PACSQuery output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 
var pACSQueryRequest = ; // {PACSQueryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesCreate(id, pACSQueryRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)
            var pACSQueryRequest = new PACSQueryRequest(); // PACSQueryRequest | 

            try {
                PACSQuery result = apiInstance.pacsQueriesCreate(id, pACSQueryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 
$pACSQueryRequest = ; // PACSQueryRequest | 

try {
    $result = $api_instance->pacsQueriesCreate($id, $pACSQueryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 
my $pACSQueryRequest = WWW::OPenAPIClient::Object::PACSQueryRequest->new(); # PACSQueryRequest | 

eval {
    my $result = $api_instance->pacsQueriesCreate(id => $id, pACSQueryRequest => $pACSQueryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)
pACSQueryRequest =  # PACSQueryRequest | 

try:
    api_response = api_instance.pacs_queries_create(id, pACSQueryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesCreate: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer
    let pACSQueryRequest = ; // PACSQueryRequest

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesCreate(id, pACSQueryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pACSQueryRequest *

Responses


pacsQueriesDestroy

A PACS query view.


/api/v1/pacs/queries/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/pacs/queries/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pacsQueriesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsQueriesDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesDestroy: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pacsQueriesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsQueriesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pacsQueriesDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.pacsQueriesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $api_instance->pacsQueriesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->pacsQueriesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.pacs_queries_destroy(id)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesDestroy: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsQueriesList

A view for the collection of all pacs queries.


/api/v1/pacs/queries/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSQueryList result = apiInstance.pacsQueriesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsQueriesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSQueryList result = apiInstance.pacsQueriesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsQueriesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPACSQueryList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSQueryList result = apiInstance.pacsQueriesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsQueriesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsQueriesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_queries_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsQueriesList2

A view for the collection of PACS-specific queries.


/api/v1/pacs/{id}/queries/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/{id}/queries/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSQueryList result = apiInstance.pacsQueriesList2(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesList2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsQueriesList2(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesList2: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSQueryList result = apiInstance.pacsQueriesList2(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesList2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsQueriesList2With:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPACSQueryList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesList2(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesList2Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSQueryList result = apiInstance.pacsQueriesList2(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesList2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsQueriesList2($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesList2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsQueriesList2(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesList2: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_queries_list2(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesList2: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesList2(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsQueriesRetrieve

A PACS query view.


/api/v1/pacs/queries/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSQuery result = apiInstance.pacsQueriesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsQueriesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesRetrieve: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSQuery result = apiInstance.pacsQueriesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsQueriesRetrieveWith:id
              completionHandler: ^(PACSQuery output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
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.pacsQueriesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PACSQuery result = apiInstance.pacsQueriesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pacsQueriesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pacsQueriesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pacs_queries_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesRetrieve: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsQueriesRetrievesCreate

A view for the collection of PACS query-specific retrieves.


/api/v1/pacs/queries/{id}/retrieves/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/{id}/retrieves/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSRetrieve result = apiInstance.pacsQueriesRetrievesCreate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsQueriesRetrievesCreate(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesRetrievesCreate: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSRetrieve result = apiInstance.pacsQueriesRetrievesCreate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsQueriesRetrievesCreateWith:id
              completionHandler: ^(PACSRetrieve output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
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.pacsQueriesRetrievesCreate(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesRetrievesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PACSRetrieve result = apiInstance.pacsQueriesRetrievesCreate(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesRetrievesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pacsQueriesRetrievesCreate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesRetrievesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pacsQueriesRetrievesCreate(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesRetrievesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pacs_queries_retrieves_create(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesRetrievesCreate: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesRetrievesCreate(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsQueriesRetrievesDestroy

A PACS retrieve view.


/api/v1/pacs/queries/retrieves/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/pacs/queries/retrieves/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pacsQueriesRetrievesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsQueriesRetrievesDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesRetrievesDestroy: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pacsQueriesRetrievesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsQueriesRetrievesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pacsQueriesRetrievesDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesRetrievesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.pacsQueriesRetrievesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesRetrievesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $api_instance->pacsQueriesRetrievesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesRetrievesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->pacsQueriesRetrievesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesRetrievesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.pacs_queries_retrieves_destroy(id)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesRetrievesDestroy: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesRetrievesDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsQueriesRetrievesList

A view for the collection of PACS query-specific retrieves.


/api/v1/pacs/queries/{id}/retrieves/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/{id}/retrieves/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSRetrieveList result = apiInstance.pacsQueriesRetrievesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsQueriesRetrievesList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesRetrievesList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSRetrieveList result = apiInstance.pacsQueriesRetrievesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsQueriesRetrievesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPACSRetrieveList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesRetrievesList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesRetrievesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSRetrieveList result = apiInstance.pacsQueriesRetrievesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesRetrievesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsQueriesRetrievesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesRetrievesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsQueriesRetrievesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesRetrievesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_queries_retrieves_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesRetrievesList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesRetrievesList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsQueriesRetrievesRetrieve

A PACS retrieve view.


/api/v1/pacs/queries/retrieves/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/retrieves/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSRetrieve result = apiInstance.pacsQueriesRetrievesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsQueriesRetrievesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesRetrievesRetrieve: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSRetrieve result = apiInstance.pacsQueriesRetrievesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsQueriesRetrievesRetrieveWith:id
              completionHandler: ^(PACSRetrieve output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
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.pacsQueriesRetrievesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesRetrievesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PACSRetrieve result = apiInstance.pacsQueriesRetrievesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesRetrievesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pacsQueriesRetrievesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesRetrievesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pacsQueriesRetrievesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesRetrievesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pacs_queries_retrieves_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesRetrievesRetrieve: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesRetrievesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsQueriesRetrievesSearchList

A view for the collection of PACS query-specific retrieves resulting from a query search.


/api/v1/pacs/queries/{id}/retrieves/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/{id}/retrieves/search/?id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&offset=56&owner_username=ownerUsername_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedPACSRetrieveList result = apiInstance.pacsQueriesRetrievesSearchList(id, id2, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String ownerUsername = new String(); // String | 

try {
    final result = await api_instance.pacsQueriesRetrievesSearchList(id, id2, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesRetrievesSearchList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedPACSRetrieveList result = apiInstance.pacsQueriesRetrievesSearchList(id, id2, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesRetrievesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *ownerUsername = ownerUsername_example; //  (optional) (default to null)

[apiInstance pacsQueriesRetrievesSearchListWith:id
    id2:id2
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    offset:offset
    ownerUsername:ownerUsername
              completionHandler: ^(PaginatedPACSRetrieveList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'ownerUsername': ownerUsername_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesRetrievesSearchList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesRetrievesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var ownerUsername = ownerUsername_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPACSRetrieveList result = apiInstance.pacsQueriesRetrievesSearchList(id, id2, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesRetrievesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | The initial index from which to return the results.
$ownerUsername = ownerUsername_example; // String | 

try {
    $result = $api_instance->pacsQueriesRetrievesSearchList($id, $id2, $limit, $maxCreationDate, $minCreationDate, $offset, $ownerUsername);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesRetrievesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $ownerUsername = ownerUsername_example; # String | 

eval {
    my $result = $api_instance->pacsQueriesRetrievesSearchList(id => $id, id2 => $id2, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, offset => $offset, ownerUsername => $ownerUsername);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesRetrievesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
ownerUsername = ownerUsername_example # String |  (optional) (default to null)

try:
    api_response = api_instance.pacs_queries_retrieves_search_list(id, id2=id2, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, offset=offset, ownerUsername=ownerUsername)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesRetrievesSearchList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let offset = 56; // Integer
    let ownerUsername = ownerUsername_example; // String

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesRetrievesSearchList(id, id2, limit, maxCreationDate, minCreationDate, offset, ownerUsername, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
offset
Integer
The initial index from which to return the results.
owner_username
String

Responses


pacsQueriesSearchList

A view for the collection of workflows resulting from a query search.


/api/v1/pacs/queries/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/queries/search/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSQueryList result = apiInstance.pacsQueriesSearchList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsQueriesSearchList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesSearchList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSQueryList result = apiInstance.pacsQueriesSearchList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsQueriesSearchListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPACSQueryList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSQueryList result = apiInstance.pacsQueriesSearchList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsQueriesSearchList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsQueriesSearchList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_queries_search_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesSearchList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesSearchList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsQueriesUpdate

A PACS query view.


/api/v1/pacs/queries/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pacs/queries/{id}/" \
 -d '{
  "query" : "",
  "description" : "description",
  "title" : "title"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        PACSQueryRequest pACSQueryRequest = ; // PACSQueryRequest | 

        try {
            PACSQuery result = apiInstance.pacsQueriesUpdate(id, pACSQueryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final PACSQueryRequest pACSQueryRequest = new PACSQueryRequest(); // PACSQueryRequest | 

try {
    final result = await api_instance.pacsQueriesUpdate(id, pACSQueryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsQueriesUpdate: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        PACSQueryRequest pACSQueryRequest = ; // PACSQueryRequest | 

        try {
            PACSQuery result = apiInstance.pacsQueriesUpdate(id, pACSQueryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsQueriesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)
PACSQueryRequest *pACSQueryRequest = ; // 

[apiInstance pacsQueriesUpdateWith:id
    pACSQueryRequest:pACSQueryRequest
              completionHandler: ^(PACSQuery output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 
var pACSQueryRequest = ; // {PACSQueryRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsQueriesUpdate(id, pACSQueryRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsQueriesUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)
            var pACSQueryRequest = new PACSQueryRequest(); // PACSQueryRequest | 

            try {
                PACSQuery result = apiInstance.pacsQueriesUpdate(id, pACSQueryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsQueriesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 
$pACSQueryRequest = ; // PACSQueryRequest | 

try {
    $result = $api_instance->pacsQueriesUpdate($id, $pACSQueryRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsQueriesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 
my $pACSQueryRequest = WWW::OPenAPIClient::Object::PACSQueryRequest->new(); # PACSQueryRequest | 

eval {
    my $result = $api_instance->pacsQueriesUpdate(id => $id, pACSQueryRequest => $pACSQueryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsQueriesUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)
pACSQueryRequest =  # PACSQueryRequest | 

try:
    api_response = api_instance.pacs_queries_update(id, pACSQueryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsQueriesUpdate: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer
    let pACSQueryRequest = ; // PACSQueryRequest

    let mut context = PacsApi::Context::default();
    let result = client.pacsQueriesUpdate(id, pACSQueryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pACSQueryRequest *

Responses


pacsRetrieve

A PACS view.


/api/v1/pacs/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACS result = apiInstance.pacsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsRetrieve: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACS result = apiInstance.pacsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsRetrieveWith:id
              completionHandler: ^(PACS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
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.pacsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PACS result = apiInstance.pacsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pacsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pacsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pacs_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsRetrieve: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsSearchList

A view for the collection of PACS resulting from a query search.


/api/v1/pacs/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/search/?active=true&id=56&identifier=identifier_example&limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Boolean active = true; // Boolean | 
        Integer id = 56; // Integer | 
        String identifier = identifier_example; // String | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSList result = apiInstance.pacsSearchList(active, id, identifier, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Boolean active = new Boolean(); // Boolean | 
final Integer id = new Integer(); // Integer | 
final String identifier = new String(); // String | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsSearchList(active, id, identifier, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsSearchList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Boolean active = true; // Boolean | 
        Integer id = 56; // Integer | 
        String identifier = identifier_example; // String | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSList result = apiInstance.pacsSearchList(active, id, identifier, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Boolean *active = true; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
String *identifier = identifier_example; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsSearchListWith:active
    id:id
    identifier:identifier
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPACSList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'active': true, // {Boolean} 
  'id': 56, // {Integer} 
  'identifier': identifier_example, // {String} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var active = true;  // Boolean |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var identifier = identifier_example;  // String |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSList result = apiInstance.pacsSearchList(active, id, identifier, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$active = true; // Boolean | 
$id = 56; // Integer | 
$identifier = identifier_example; // String | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsSearchList($active, $id, $identifier, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $active = true; # Boolean | 
my $id = 56; # Integer | 
my $identifier = identifier_example; # String | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsSearchList(active => $active, id => $id, identifier => $identifier, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
active = true # Boolean |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
identifier = identifier_example # String |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_search_list(active=active, id=id, identifier=identifier, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsSearchList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let active = true; // Boolean
    let id = 56; // Integer
    let identifier = identifier_example; // String
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsSearchList(active, id, identifier, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
active
Boolean
id
Integer
identifier
String
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsSeriesCreate

A view for the collection of all PACS Series.


/api/v1/pacs/series/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pacs/series/" \
 -d '{
  "PatientBirthDate" : "2000-01-23",
  "ProtocolName" : "ProtocolName",
  "StudyDate" : "2000-01-23",
  "ndicom" : 0,
  "StudyDescription" : "StudyDescription",
  "PatientName" : "PatientName",
  "StudyInstanceUID" : "StudyInstanceUID",
  "SeriesInstanceUID" : "SeriesInstanceUID",
  "PatientAge" : 441289069,
  "SeriesDescription" : "SeriesDescription",
  "path" : "path",
  "PatientSex" : "M",
  "PatientID" : "PatientID",
  "AccessionNumber" : "AccessionNumber",
  "Modality" : "Modality",
  "pacs_name" : "pacs_name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        PACSSeriesRequest pACSSeriesRequest = ; // PACSSeriesRequest | 

        try {
            PACSSeries result = apiInstance.pacsSeriesCreate(pACSSeriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PACSSeriesRequest pACSSeriesRequest = new PACSSeriesRequest(); // PACSSeriesRequest | 

try {
    final result = await api_instance.pacsSeriesCreate(pACSSeriesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsSeriesCreate: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        PACSSeriesRequest pACSSeriesRequest = ; // PACSSeriesRequest | 

        try {
            PACSSeries result = apiInstance.pacsSeriesCreate(pACSSeriesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
PACSSeriesRequest *pACSSeriesRequest = ; // 

[apiInstance pacsSeriesCreateWith:pACSSeriesRequest
              completionHandler: ^(PACSSeries output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var pACSSeriesRequest = ; // {PACSSeriesRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsSeriesCreate(pACSSeriesRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsSeriesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var pACSSeriesRequest = new PACSSeriesRequest(); // PACSSeriesRequest | 

            try {
                PACSSeries result = apiInstance.pacsSeriesCreate(pACSSeriesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsSeriesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$pACSSeriesRequest = ; // PACSSeriesRequest | 

try {
    $result = $api_instance->pacsSeriesCreate($pACSSeriesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsSeriesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $pACSSeriesRequest = WWW::OPenAPIClient::Object::PACSSeriesRequest->new(); # PACSSeriesRequest | 

eval {
    my $result = $api_instance->pacsSeriesCreate(pACSSeriesRequest => $pACSSeriesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsSeriesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
pACSSeriesRequest =  # PACSSeriesRequest | 

try:
    api_response = api_instance.pacs_series_create(pACSSeriesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsSeriesCreate: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let pACSSeriesRequest = ; // PACSSeriesRequest

    let mut context = PacsApi::Context::default();
    let result = client.pacsSeriesCreate(pACSSeriesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
pACSSeriesRequest *

Responses


pacsSeriesList

A view for the collection of all PACS Series.


/api/v1/pacs/series/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/series/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSSeriesList result = apiInstance.pacsSeriesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsSeriesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsSeriesList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSSeriesList result = apiInstance.pacsSeriesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsSeriesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPACSSeriesList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsSeriesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsSeriesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSSeriesList result = apiInstance.pacsSeriesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsSeriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsSeriesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsSeriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsSeriesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsSeriesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_series_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsSeriesList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsSeriesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsSeriesList2

A view for the collection of PACS-specific series.


/api/v1/pacs/{id}/series/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/{id}/series/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSSeriesList result = apiInstance.pacsSeriesList2(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesList2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pacsSeriesList2(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsSeriesList2: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPACSSeriesList result = apiInstance.pacsSeriesList2(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesList2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pacsSeriesList2With:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPACSSeriesList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsSeriesList2(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsSeriesList2Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPACSSeriesList result = apiInstance.pacsSeriesList2(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsSeriesList2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pacsSeriesList2($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsSeriesList2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pacsSeriesList2(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsSeriesList2: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pacs_series_list2(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsSeriesList2: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsSeriesList2(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pacsSeriesRetrieve

A PACS Series view.


/api/v1/pacs/series/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/series/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSSeries result = apiInstance.pacsSeriesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pacsSeriesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsSeriesRetrieve: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        Integer id = 56; // Integer | 

        try {
            PACSSeries result = apiInstance.pacsSeriesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pacsSeriesRetrieveWith:id
              completionHandler: ^(PACSSeries output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
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.pacsSeriesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsSeriesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PACSSeries result = apiInstance.pacsSeriesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsSeriesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pacsSeriesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsSeriesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pacsSeriesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsSeriesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pacs_series_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsSeriesRetrieve: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PacsApi::Context::default();
    let result = client.pacsSeriesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pacsSeriesSearchList

A view for the collection of PACS Series resulting from a query search.


/api/v1/pacs/series/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pacs/series/search/?AccessionNumber=accessionNumber_example&PatientAge=56&PatientBirthDate=2013-10-20&PatientID=patientID_example&PatientName=patientName_example&PatientSex=patientSex_example&ProtocolName=protocolName_example&SeriesDescription=seriesDescription_example&SeriesInstanceUID=seriesInstanceUID_example&StudyDate=2013-10-20&StudyDescription=studyDescription_example&StudyInstanceUID=studyInstanceUID_example&id=56&limit=56&max_PatientAge=56&max_creation_date=2013-10-20T19:20:30+01:00&min_PatientAge=56&min_creation_date=2013-10-20T19:20:30+01:00&offset=56&pacs_id=pacsId_example&pacs_identifier=pacsIdentifier_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PacsApi;

import java.io.File;
import java.util.*;

public class PacsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PacsApi apiInstance = new PacsApi();
        String accessionNumber = accessionNumber_example; // String | 
        Integer patientAge = 56; // Integer | 
        date patientBirthDate = 2013-10-20; // date | 
        String patientID = patientID_example; // String | 
        String patientName = patientName_example; // String | 
        String patientSex = patientSex_example; // String | * `M` - Male
* `F` - Female
* `O` - Other
        String protocolName = protocolName_example; // String | 
        String seriesDescription = seriesDescription_example; // String | 
        String seriesInstanceUID = seriesInstanceUID_example; // String | 
        date studyDate = 2013-10-20; // date | 
        String studyDescription = studyDescription_example; // String | 
        String studyInstanceUID = studyInstanceUID_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer maxPatientAge = 56; // Integer | 
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer minPatientAge = 56; // Integer | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String pacsId = pacsId_example; // String | 
        String pacsIdentifier = pacsIdentifier_example; // String | 

        try {
            PaginatedPACSSeriesList result = apiInstance.pacsSeriesSearchList(accessionNumber, patientAge, patientBirthDate, patientID, patientName, patientSex, protocolName, seriesDescription, seriesInstanceUID, studyDate, studyDescription, studyInstanceUID, id, limit, maxPatientAge, maxCreationDate, minPatientAge, minCreationDate, offset, pacsId, pacsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accessionNumber = new String(); // String | 
final Integer patientAge = new Integer(); // Integer | 
final date patientBirthDate = new date(); // date | 
final String patientID = new String(); // String | 
final String patientName = new String(); // String | 
final String patientSex = new String(); // String | * `M` - Male
* `F` - Female
* `O` - Other
final String protocolName = new String(); // String | 
final String seriesDescription = new String(); // String | 
final String seriesInstanceUID = new String(); // String | 
final date studyDate = new date(); // date | 
final String studyDescription = new String(); // String | 
final String studyInstanceUID = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer maxPatientAge = new Integer(); // Integer | 
final Date maxCreationDate = new Date(); // Date | 
final Integer minPatientAge = new Integer(); // Integer | 
final Date minCreationDate = new Date(); // Date | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String pacsId = new String(); // String | 
final String pacsIdentifier = new String(); // String | 

try {
    final result = await api_instance.pacsSeriesSearchList(accessionNumber, patientAge, patientBirthDate, patientID, patientName, patientSex, protocolName, seriesDescription, seriesInstanceUID, studyDate, studyDescription, studyInstanceUID, id, limit, maxPatientAge, maxCreationDate, minPatientAge, minCreationDate, offset, pacsId, pacsIdentifier);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pacsSeriesSearchList: $e\n');
}

import org.openapitools.client.api.PacsApi;

public class PacsApiExample {
    public static void main(String[] args) {
        PacsApi apiInstance = new PacsApi();
        String accessionNumber = accessionNumber_example; // String | 
        Integer patientAge = 56; // Integer | 
        date patientBirthDate = 2013-10-20; // date | 
        String patientID = patientID_example; // String | 
        String patientName = patientName_example; // String | 
        String patientSex = patientSex_example; // String | * `M` - Male
* `F` - Female
* `O` - Other
        String protocolName = protocolName_example; // String | 
        String seriesDescription = seriesDescription_example; // String | 
        String seriesInstanceUID = seriesInstanceUID_example; // String | 
        date studyDate = 2013-10-20; // date | 
        String studyDescription = studyDescription_example; // String | 
        String studyInstanceUID = studyInstanceUID_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer maxPatientAge = 56; // Integer | 
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer minPatientAge = 56; // Integer | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String pacsId = pacsId_example; // String | 
        String pacsIdentifier = pacsIdentifier_example; // String | 

        try {
            PaginatedPACSSeriesList result = apiInstance.pacsSeriesSearchList(accessionNumber, patientAge, patientBirthDate, patientID, patientName, patientSex, protocolName, seriesDescription, seriesInstanceUID, studyDate, studyDescription, studyInstanceUID, id, limit, maxPatientAge, maxCreationDate, minPatientAge, minCreationDate, offset, pacsId, pacsIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PacsApi#pacsSeriesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PacsApi *apiInstance = [[PacsApi alloc] init];
String *accessionNumber = accessionNumber_example; //  (optional) (default to null)
Integer *patientAge = 56; //  (optional) (default to null)
date *patientBirthDate = 2013-10-20; //  (optional) (default to null)
String *patientID = patientID_example; //  (optional) (default to null)
String *patientName = patientName_example; //  (optional) (default to null)
String *patientSex = patientSex_example; // * `M` - Male
* `F` - Female
* `O` - Other (optional) (default to null)
String *protocolName = protocolName_example; //  (optional) (default to null)
String *seriesDescription = seriesDescription_example; //  (optional) (default to null)
String *seriesInstanceUID = seriesInstanceUID_example; //  (optional) (default to null)
date *studyDate = 2013-10-20; //  (optional) (default to null)
String *studyDescription = studyDescription_example; //  (optional) (default to null)
String *studyInstanceUID = studyInstanceUID_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *maxPatientAge = 56; //  (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *minPatientAge = 56; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *pacsId = pacsId_example; //  (optional) (default to null)
String *pacsIdentifier = pacsIdentifier_example; //  (optional) (default to null)

[apiInstance pacsSeriesSearchListWith:accessionNumber
    patientAge:patientAge
    patientBirthDate:patientBirthDate
    patientID:patientID
    patientName:patientName
    patientSex:patientSex
    protocolName:protocolName
    seriesDescription:seriesDescription
    seriesInstanceUID:seriesInstanceUID
    studyDate:studyDate
    studyDescription:studyDescription
    studyInstanceUID:studyInstanceUID
    id:id
    limit:limit
    maxPatientAge:maxPatientAge
    maxCreationDate:maxCreationDate
    minPatientAge:minPatientAge
    minCreationDate:minCreationDate
    offset:offset
    pacsId:pacsId
    pacsIdentifier:pacsIdentifier
              completionHandler: ^(PaginatedPACSSeriesList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PacsApi()
var opts = {
  'accessionNumber': accessionNumber_example, // {String} 
  'patientAge': 56, // {Integer} 
  'patientBirthDate': 2013-10-20, // {date} 
  'patientID': patientID_example, // {String} 
  'patientName': patientName_example, // {String} 
  'patientSex': patientSex_example, // {String} * `M` - Male
* `F` - Female
* `O` - Other
  'protocolName': protocolName_example, // {String} 
  'seriesDescription': seriesDescription_example, // {String} 
  'seriesInstanceUID': seriesInstanceUID_example, // {String} 
  'studyDate': 2013-10-20, // {date} 
  'studyDescription': studyDescription_example, // {String} 
  'studyInstanceUID': studyInstanceUID_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxPatientAge': 56, // {Integer} 
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minPatientAge': 56, // {Integer} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'pacsId': pacsId_example, // {String} 
  'pacsIdentifier': pacsIdentifier_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pacsSeriesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pacsSeriesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PacsApi();
            var accessionNumber = accessionNumber_example;  // String |  (optional)  (default to null)
            var patientAge = 56;  // Integer |  (optional)  (default to null)
            var patientBirthDate = 2013-10-20;  // date |  (optional)  (default to null)
            var patientID = patientID_example;  // String |  (optional)  (default to null)
            var patientName = patientName_example;  // String |  (optional)  (default to null)
            var patientSex = patientSex_example;  // String | * `M` - Male
* `F` - Female
* `O` - Other (optional)  (default to null)
            var protocolName = protocolName_example;  // String |  (optional)  (default to null)
            var seriesDescription = seriesDescription_example;  // String |  (optional)  (default to null)
            var seriesInstanceUID = seriesInstanceUID_example;  // String |  (optional)  (default to null)
            var studyDate = 2013-10-20;  // date |  (optional)  (default to null)
            var studyDescription = studyDescription_example;  // String |  (optional)  (default to null)
            var studyInstanceUID = studyInstanceUID_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxPatientAge = 56;  // Integer |  (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minPatientAge = 56;  // Integer |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var pacsId = pacsId_example;  // String |  (optional)  (default to null)
            var pacsIdentifier = pacsIdentifier_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPACSSeriesList result = apiInstance.pacsSeriesSearchList(accessionNumber, patientAge, patientBirthDate, patientID, patientName, patientSex, protocolName, seriesDescription, seriesInstanceUID, studyDate, studyDescription, studyInstanceUID, id, limit, maxPatientAge, maxCreationDate, minPatientAge, minCreationDate, offset, pacsId, pacsIdentifier);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PacsApi.pacsSeriesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PacsApi();
$accessionNumber = accessionNumber_example; // String | 
$patientAge = 56; // Integer | 
$patientBirthDate = 2013-10-20; // date | 
$patientID = patientID_example; // String | 
$patientName = patientName_example; // String | 
$patientSex = patientSex_example; // String | * `M` - Male
* `F` - Female
* `O` - Other
$protocolName = protocolName_example; // String | 
$seriesDescription = seriesDescription_example; // String | 
$seriesInstanceUID = seriesInstanceUID_example; // String | 
$studyDate = 2013-10-20; // date | 
$studyDescription = studyDescription_example; // String | 
$studyInstanceUID = studyInstanceUID_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxPatientAge = 56; // Integer | 
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minPatientAge = 56; // Integer | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | The initial index from which to return the results.
$pacsId = pacsId_example; // String | 
$pacsIdentifier = pacsIdentifier_example; // String | 

try {
    $result = $api_instance->pacsSeriesSearchList($accessionNumber, $patientAge, $patientBirthDate, $patientID, $patientName, $patientSex, $protocolName, $seriesDescription, $seriesInstanceUID, $studyDate, $studyDescription, $studyInstanceUID, $id, $limit, $maxPatientAge, $maxCreationDate, $minPatientAge, $minCreationDate, $offset, $pacsId, $pacsIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PacsApi->pacsSeriesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PacsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PacsApi->new();
my $accessionNumber = accessionNumber_example; # String | 
my $patientAge = 56; # Integer | 
my $patientBirthDate = 2013-10-20; # date | 
my $patientID = patientID_example; # String | 
my $patientName = patientName_example; # String | 
my $patientSex = patientSex_example; # String | * `M` - Male
* `F` - Female
* `O` - Other
my $protocolName = protocolName_example; # String | 
my $seriesDescription = seriesDescription_example; # String | 
my $seriesInstanceUID = seriesInstanceUID_example; # String | 
my $studyDate = 2013-10-20; # date | 
my $studyDescription = studyDescription_example; # String | 
my $studyInstanceUID = studyInstanceUID_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxPatientAge = 56; # Integer | 
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minPatientAge = 56; # Integer | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $pacsId = pacsId_example; # String | 
my $pacsIdentifier = pacsIdentifier_example; # String | 

eval {
    my $result = $api_instance->pacsSeriesSearchList(accessionNumber => $accessionNumber, patientAge => $patientAge, patientBirthDate => $patientBirthDate, patientID => $patientID, patientName => $patientName, patientSex => $patientSex, protocolName => $protocolName, seriesDescription => $seriesDescription, seriesInstanceUID => $seriesInstanceUID, studyDate => $studyDate, studyDescription => $studyDescription, studyInstanceUID => $studyInstanceUID, id => $id, limit => $limit, maxPatientAge => $maxPatientAge, maxCreationDate => $maxCreationDate, minPatientAge => $minPatientAge, minCreationDate => $minCreationDate, offset => $offset, pacsId => $pacsId, pacsIdentifier => $pacsIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PacsApi->pacsSeriesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PacsApi()
accessionNumber = accessionNumber_example # String |  (optional) (default to null)
patientAge = 56 # Integer |  (optional) (default to null)
patientBirthDate = 2013-10-20 # date |  (optional) (default to null)
patientID = patientID_example # String |  (optional) (default to null)
patientName = patientName_example # String |  (optional) (default to null)
patientSex = patientSex_example # String | * `M` - Male
* `F` - Female
* `O` - Other (optional) (default to null)
protocolName = protocolName_example # String |  (optional) (default to null)
seriesDescription = seriesDescription_example # String |  (optional) (default to null)
seriesInstanceUID = seriesInstanceUID_example # String |  (optional) (default to null)
studyDate = 2013-10-20 # date |  (optional) (default to null)
studyDescription = studyDescription_example # String |  (optional) (default to null)
studyInstanceUID = studyInstanceUID_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxPatientAge = 56 # Integer |  (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minPatientAge = 56 # Integer |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
pacsId = pacsId_example # String |  (optional) (default to null)
pacsIdentifier = pacsIdentifier_example # String |  (optional) (default to null)

try:
    api_response = api_instance.pacs_series_search_list(accessionNumber=accessionNumber, patientAge=patientAge, patientBirthDate=patientBirthDate, patientID=patientID, patientName=patientName, patientSex=patientSex, protocolName=protocolName, seriesDescription=seriesDescription, seriesInstanceUID=seriesInstanceUID, studyDate=studyDate, studyDescription=studyDescription, studyInstanceUID=studyInstanceUID, id=id, limit=limit, maxPatientAge=maxPatientAge, maxCreationDate=maxCreationDate, minPatientAge=minPatientAge, minCreationDate=minCreationDate, offset=offset, pacsId=pacsId, pacsIdentifier=pacsIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PacsApi->pacsSeriesSearchList: %s\n" % e)
extern crate PacsApi;

pub fn main() {
    let accessionNumber = accessionNumber_example; // String
    let patientAge = 56; // Integer
    let patientBirthDate = 2013-10-20; // date
    let patientID = patientID_example; // String
    let patientName = patientName_example; // String
    let patientSex = patientSex_example; // String
    let protocolName = protocolName_example; // String
    let seriesDescription = seriesDescription_example; // String
    let seriesInstanceUID = seriesInstanceUID_example; // String
    let studyDate = 2013-10-20; // date
    let studyDescription = studyDescription_example; // String
    let studyInstanceUID = studyInstanceUID_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxPatientAge = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minPatientAge = 56; // Integer
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let offset = 56; // Integer
    let pacsId = pacsId_example; // String
    let pacsIdentifier = pacsIdentifier_example; // String

    let mut context = PacsApi::Context::default();
    let result = client.pacsSeriesSearchList(accessionNumber, patientAge, patientBirthDate, patientID, patientName, patientSex, protocolName, seriesDescription, seriesInstanceUID, studyDate, studyDescription, studyInstanceUID, id, limit, maxPatientAge, maxCreationDate, minPatientAge, minCreationDate, offset, pacsId, pacsIdentifier, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
AccessionNumber
String
PatientAge
Integer
PatientBirthDate
date (date)
PatientID
String
PatientName
String
PatientSex
String
* `M` - Male * `F` - Female * `O` - Other
ProtocolName
String
SeriesDescription
String
SeriesInstanceUID
String
StudyDate
date (date)
StudyDescription
String
StudyInstanceUID
String
id
Integer
limit
Integer
Number of results to return per page.
max_PatientAge
Integer
max_creation_date
Date (date-time)
min_PatientAge
Integer
min_creation_date
Date (date-time)
offset
Integer
The initial index from which to return the results.
pacs_id
String
pacs_identifier
String

Responses


Pipelines

allWorkflowsList

A view for the collection of all workflows.


/api/v1/pipelines/workflows/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/workflows/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedWorkflowList result = apiInstance.allWorkflowsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#allWorkflowsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.allWorkflowsList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->allWorkflowsList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedWorkflowList result = apiInstance.allWorkflowsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#allWorkflowsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance allWorkflowsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedWorkflowList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allWorkflowsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class allWorkflowsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedWorkflowList result = apiInstance.allWorkflowsList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.allWorkflowsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->allWorkflowsList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->allWorkflowsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->allWorkflowsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->allWorkflowsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.all_workflows_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->allWorkflowsList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.allWorkflowsList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesBooleanParameterRetrieve

A view for a boolean default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/boolean-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/boolean-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingBoolParameter result = apiInstance.pipelinesBooleanParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesBooleanParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesBooleanParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesBooleanParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingBoolParameter result = apiInstance.pipelinesBooleanParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesBooleanParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesBooleanParameterRetrieveWith:id
              completionHandler: ^(DefaultPipingBoolParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesBooleanParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesBooleanParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                DefaultPipingBoolParameter result = apiInstance.pipelinesBooleanParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesBooleanParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesBooleanParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesBooleanParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesBooleanParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesBooleanParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_boolean_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesBooleanParameterRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesBooleanParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesBooleanParameterUpdate

A view for a boolean default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/boolean-parameter/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/boolean-parameter/{id}/" \
 -d '{
  "value" : true
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingBoolParameterRequest defaultPipingBoolParameterRequest = ; // DefaultPipingBoolParameterRequest | 

        try {
            DefaultPipingBoolParameter result = apiInstance.pipelinesBooleanParameterUpdate(id, defaultPipingBoolParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesBooleanParameterUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final DefaultPipingBoolParameterRequest defaultPipingBoolParameterRequest = new DefaultPipingBoolParameterRequest(); // DefaultPipingBoolParameterRequest | 

try {
    final result = await api_instance.pipelinesBooleanParameterUpdate(id, defaultPipingBoolParameterRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesBooleanParameterUpdate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingBoolParameterRequest defaultPipingBoolParameterRequest = ; // DefaultPipingBoolParameterRequest | 

        try {
            DefaultPipingBoolParameter result = apiInstance.pipelinesBooleanParameterUpdate(id, defaultPipingBoolParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesBooleanParameterUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
DefaultPipingBoolParameterRequest *defaultPipingBoolParameterRequest = ; //  (optional)

[apiInstance pipelinesBooleanParameterUpdateWith:id
    defaultPipingBoolParameterRequest:defaultPipingBoolParameterRequest
              completionHandler: ^(DefaultPipingBoolParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'defaultPipingBoolParameterRequest':  // {DefaultPipingBoolParameterRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesBooleanParameterUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesBooleanParameterUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var defaultPipingBoolParameterRequest = new DefaultPipingBoolParameterRequest(); // DefaultPipingBoolParameterRequest |  (optional) 

            try {
                DefaultPipingBoolParameter result = apiInstance.pipelinesBooleanParameterUpdate(id, defaultPipingBoolParameterRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesBooleanParameterUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$defaultPipingBoolParameterRequest = ; // DefaultPipingBoolParameterRequest | 

try {
    $result = $api_instance->pipelinesBooleanParameterUpdate($id, $defaultPipingBoolParameterRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesBooleanParameterUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $defaultPipingBoolParameterRequest = WWW::OPenAPIClient::Object::DefaultPipingBoolParameterRequest->new(); # DefaultPipingBoolParameterRequest | 

eval {
    my $result = $api_instance->pipelinesBooleanParameterUpdate(id => $id, defaultPipingBoolParameterRequest => $defaultPipingBoolParameterRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesBooleanParameterUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
defaultPipingBoolParameterRequest =  # DefaultPipingBoolParameterRequest |  (optional)

try:
    api_response = api_instance.pipelines_boolean_parameter_update(id, defaultPipingBoolParameterRequest=defaultPipingBoolParameterRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesBooleanParameterUpdate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let defaultPipingBoolParameterRequest = ; // DefaultPipingBoolParameterRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesBooleanParameterUpdate(id, defaultPipingBoolParameterRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
defaultPipingBoolParameterRequest

Responses


pipelinesCreate

A view for the collection of pipelines.


/api/v1/pipelines/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/" \
 -d '{
  "plugin_inst_id" : 1,
  "plugin_tree" : "",
  "name" : "name",
  "description" : "description",
  "locked" : true,
  "category" : "category",
  "authors" : "authors"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        PipelineRequest pipelineRequest = ; // PipelineRequest | 

        try {
            Pipeline result = apiInstance.pipelinesCreate(pipelineRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PipelineRequest pipelineRequest = new PipelineRequest(); // PipelineRequest | 

try {
    final result = await api_instance.pipelinesCreate(pipelineRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesCreate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        PipelineRequest pipelineRequest = ; // PipelineRequest | 

        try {
            Pipeline result = apiInstance.pipelinesCreate(pipelineRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
PipelineRequest *pipelineRequest = ; // 

[apiInstance pipelinesCreateWith:pipelineRequest
              completionHandler: ^(Pipeline output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var pipelineRequest = ; // {PipelineRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesCreate(pipelineRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var pipelineRequest = new PipelineRequest(); // PipelineRequest | 

            try {
                Pipeline result = apiInstance.pipelinesCreate(pipelineRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$pipelineRequest = ; // PipelineRequest | 

try {
    $result = $api_instance->pipelinesCreate($pipelineRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $pipelineRequest = WWW::OPenAPIClient::Object::PipelineRequest->new(); # PipelineRequest | 

eval {
    my $result = $api_instance->pipelinesCreate(pipelineRequest => $pipelineRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
pipelineRequest =  # PipelineRequest | 

try:
    api_response = api_instance.pipelines_create(pipelineRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesCreate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let pipelineRequest = ; // PipelineRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesCreate(pipelineRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
pipelineRequest *

Responses


pipelinesDestroy

A pipeline view.


/api/v1/pipelines/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/pipelines/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pipelinesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesDestroy: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pipelinesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pipelinesDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.pipelinesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $api_instance->pipelinesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->pipelinesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.pipelines_destroy(id)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesDestroy: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesFloatParameterRetrieve

A view for a float default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/float-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/float-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingFloatParameter result = apiInstance.pipelinesFloatParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesFloatParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesFloatParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesFloatParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingFloatParameter result = apiInstance.pipelinesFloatParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesFloatParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesFloatParameterRetrieveWith:id
              completionHandler: ^(DefaultPipingFloatParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesFloatParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesFloatParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                DefaultPipingFloatParameter result = apiInstance.pipelinesFloatParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesFloatParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesFloatParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesFloatParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesFloatParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesFloatParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_float_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesFloatParameterRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesFloatParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesFloatParameterUpdate

A view for a float default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/float-parameter/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/float-parameter/{id}/" \
 -d '{
  "value" : 0.8008281904610115
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingFloatParameterRequest defaultPipingFloatParameterRequest = ; // DefaultPipingFloatParameterRequest | 

        try {
            DefaultPipingFloatParameter result = apiInstance.pipelinesFloatParameterUpdate(id, defaultPipingFloatParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesFloatParameterUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final DefaultPipingFloatParameterRequest defaultPipingFloatParameterRequest = new DefaultPipingFloatParameterRequest(); // DefaultPipingFloatParameterRequest | 

try {
    final result = await api_instance.pipelinesFloatParameterUpdate(id, defaultPipingFloatParameterRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesFloatParameterUpdate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingFloatParameterRequest defaultPipingFloatParameterRequest = ; // DefaultPipingFloatParameterRequest | 

        try {
            DefaultPipingFloatParameter result = apiInstance.pipelinesFloatParameterUpdate(id, defaultPipingFloatParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesFloatParameterUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
DefaultPipingFloatParameterRequest *defaultPipingFloatParameterRequest = ; //  (optional)

[apiInstance pipelinesFloatParameterUpdateWith:id
    defaultPipingFloatParameterRequest:defaultPipingFloatParameterRequest
              completionHandler: ^(DefaultPipingFloatParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'defaultPipingFloatParameterRequest':  // {DefaultPipingFloatParameterRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesFloatParameterUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesFloatParameterUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var defaultPipingFloatParameterRequest = new DefaultPipingFloatParameterRequest(); // DefaultPipingFloatParameterRequest |  (optional) 

            try {
                DefaultPipingFloatParameter result = apiInstance.pipelinesFloatParameterUpdate(id, defaultPipingFloatParameterRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesFloatParameterUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$defaultPipingFloatParameterRequest = ; // DefaultPipingFloatParameterRequest | 

try {
    $result = $api_instance->pipelinesFloatParameterUpdate($id, $defaultPipingFloatParameterRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesFloatParameterUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $defaultPipingFloatParameterRequest = WWW::OPenAPIClient::Object::DefaultPipingFloatParameterRequest->new(); # DefaultPipingFloatParameterRequest | 

eval {
    my $result = $api_instance->pipelinesFloatParameterUpdate(id => $id, defaultPipingFloatParameterRequest => $defaultPipingFloatParameterRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesFloatParameterUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
defaultPipingFloatParameterRequest =  # DefaultPipingFloatParameterRequest |  (optional)

try:
    api_response = api_instance.pipelines_float_parameter_update(id, defaultPipingFloatParameterRequest=defaultPipingFloatParameterRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesFloatParameterUpdate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let defaultPipingFloatParameterRequest = ; // DefaultPipingFloatParameterRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesFloatParameterUpdate(id, defaultPipingFloatParameterRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
defaultPipingFloatParameterRequest

Responses


pipelinesIntegerParameterRetrieve

A view for an integer default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/integer-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/integer-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingIntParameter result = apiInstance.pipelinesIntegerParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesIntegerParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesIntegerParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesIntegerParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingIntParameter result = apiInstance.pipelinesIntegerParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesIntegerParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesIntegerParameterRetrieveWith:id
              completionHandler: ^(DefaultPipingIntParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesIntegerParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesIntegerParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                DefaultPipingIntParameter result = apiInstance.pipelinesIntegerParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesIntegerParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesIntegerParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesIntegerParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesIntegerParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesIntegerParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_integer_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesIntegerParameterRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesIntegerParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesIntegerParameterUpdate

A view for an integer default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/integer-parameter/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/integer-parameter/{id}/" \
 -d '{
  "value" : -1803530559
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingIntParameterRequest defaultPipingIntParameterRequest = ; // DefaultPipingIntParameterRequest | 

        try {
            DefaultPipingIntParameter result = apiInstance.pipelinesIntegerParameterUpdate(id, defaultPipingIntParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesIntegerParameterUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final DefaultPipingIntParameterRequest defaultPipingIntParameterRequest = new DefaultPipingIntParameterRequest(); // DefaultPipingIntParameterRequest | 

try {
    final result = await api_instance.pipelinesIntegerParameterUpdate(id, defaultPipingIntParameterRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesIntegerParameterUpdate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingIntParameterRequest defaultPipingIntParameterRequest = ; // DefaultPipingIntParameterRequest | 

        try {
            DefaultPipingIntParameter result = apiInstance.pipelinesIntegerParameterUpdate(id, defaultPipingIntParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesIntegerParameterUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
DefaultPipingIntParameterRequest *defaultPipingIntParameterRequest = ; //  (optional)

[apiInstance pipelinesIntegerParameterUpdateWith:id
    defaultPipingIntParameterRequest:defaultPipingIntParameterRequest
              completionHandler: ^(DefaultPipingIntParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'defaultPipingIntParameterRequest':  // {DefaultPipingIntParameterRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesIntegerParameterUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesIntegerParameterUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var defaultPipingIntParameterRequest = new DefaultPipingIntParameterRequest(); // DefaultPipingIntParameterRequest |  (optional) 

            try {
                DefaultPipingIntParameter result = apiInstance.pipelinesIntegerParameterUpdate(id, defaultPipingIntParameterRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesIntegerParameterUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$defaultPipingIntParameterRequest = ; // DefaultPipingIntParameterRequest | 

try {
    $result = $api_instance->pipelinesIntegerParameterUpdate($id, $defaultPipingIntParameterRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesIntegerParameterUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $defaultPipingIntParameterRequest = WWW::OPenAPIClient::Object::DefaultPipingIntParameterRequest->new(); # DefaultPipingIntParameterRequest | 

eval {
    my $result = $api_instance->pipelinesIntegerParameterUpdate(id => $id, defaultPipingIntParameterRequest => $defaultPipingIntParameterRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesIntegerParameterUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
defaultPipingIntParameterRequest =  # DefaultPipingIntParameterRequest |  (optional)

try:
    api_response = api_instance.pipelines_integer_parameter_update(id, defaultPipingIntParameterRequest=defaultPipingIntParameterRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesIntegerParameterUpdate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let defaultPipingIntParameterRequest = ; // DefaultPipingIntParameterRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesIntegerParameterUpdate(id, defaultPipingIntParameterRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
defaultPipingIntParameterRequest

Responses


pipelinesJsonRetrieve

A pipeline with a custom JSON view resembling the originally submitted pipeline data.


/api/v1/pipelines/{id}/json/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/{id}/json/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            PipelineCustomJson result = apiInstance.pipelinesJsonRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesJsonRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesJsonRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesJsonRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            PipelineCustomJson result = apiInstance.pipelinesJsonRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesJsonRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesJsonRetrieveWith:id
              completionHandler: ^(PipelineCustomJson output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesJsonRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesJsonRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PipelineCustomJson result = apiInstance.pipelinesJsonRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesJsonRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesJsonRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesJsonRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesJsonRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesJsonRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_json_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesJsonRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesJsonRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesList

A view for the collection of pipelines.


/api/v1/pipelines/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPipelineList result = apiInstance.pipelinesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pipelinesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPipelineList result = apiInstance.pipelinesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pipelinesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPipelineList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPipelineList result = apiInstance.pipelinesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pipelinesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pipelinesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pipelines_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesParametersList

A view for the collection of pipeline-specific plugin parameters' defaults.


/api/v1/pipelines/{id}/parameters/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/{id}/parameters/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGenericDefaultPipingParameterList result = apiInstance.pipelinesParametersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesParametersList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pipelinesParametersList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesParametersList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGenericDefaultPipingParameterList result = apiInstance.pipelinesParametersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesParametersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pipelinesParametersListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedGenericDefaultPipingParameterList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesParametersList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesParametersListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedGenericDefaultPipingParameterList result = apiInstance.pipelinesParametersList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesParametersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pipelinesParametersList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesParametersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pipelinesParametersList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesParametersList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pipelines_parameters_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesParametersList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesParametersList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesPipingsList

A view for the collection of pipeline-specific plugin pipings.


/api/v1/pipelines/{id}/pipings/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/{id}/pipings/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginPipingList result = apiInstance.pipelinesPipingsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesPipingsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pipelinesPipingsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesPipingsList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginPipingList result = apiInstance.pipelinesPipingsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesPipingsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pipelinesPipingsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginPipingList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesPipingsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesPipingsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginPipingList result = apiInstance.pipelinesPipingsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesPipingsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pipelinesPipingsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesPipingsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pipelinesPipingsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesPipingsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pipelines_pipings_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesPipingsList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesPipingsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesPipingsRetrieve

A plugin piping view.


/api/v1/pipelines/pipings/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/pipings/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            PluginPiping result = apiInstance.pipelinesPipingsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesPipingsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesPipingsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesPipingsRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            PluginPiping result = apiInstance.pipelinesPipingsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesPipingsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesPipingsRetrieveWith:id
              completionHandler: ^(PluginPiping output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesPipingsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesPipingsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PluginPiping result = apiInstance.pipelinesPipingsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesPipingsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesPipingsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesPipingsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesPipingsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesPipingsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_pipings_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesPipingsRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesPipingsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesPluginsList

A view for a pipeline-specific collection of plugins.


/api/v1/pipelines/{id}/plugins/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/{id}/plugins/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginList result = apiInstance.pipelinesPluginsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesPluginsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pipelinesPluginsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesPluginsList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginList result = apiInstance.pipelinesPluginsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesPluginsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pipelinesPluginsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesPluginsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesPluginsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginList result = apiInstance.pipelinesPluginsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesPluginsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pipelinesPluginsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesPluginsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pipelinesPluginsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesPluginsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pipelines_plugins_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesPluginsList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesPluginsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesRetrieve

A pipeline view.


/api/v1/pipelines/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            Pipeline result = apiInstance.pipelinesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            Pipeline result = apiInstance.pipelinesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesRetrieveWith:id
              completionHandler: ^(Pipeline output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Pipeline result = apiInstance.pipelinesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesSearchList

A view for the collection of pipelines resulting from a query search.


/api/v1/pipelines/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/search/?authors=authors_example&category=category_example&description=description_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&name=name_example&offset=56&owner_username=ownerUsername_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        String authors = authors_example; // String | 
        String category = category_example; // String | 
        String description = description_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        String name = name_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedPipelineList result = apiInstance.pipelinesSearchList(authors, category, description, id, limit, maxCreationDate, minCreationDate, name, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String authors = new String(); // String | 
final String category = new String(); // String | 
final String description = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final String name = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String ownerUsername = new String(); // String | 

try {
    final result = await api_instance.pipelinesSearchList(authors, category, description, id, limit, maxCreationDate, minCreationDate, name, offset, ownerUsername);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesSearchList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        String authors = authors_example; // String | 
        String category = category_example; // String | 
        String description = description_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        String name = name_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedPipelineList result = apiInstance.pipelinesSearchList(authors, category, description, id, limit, maxCreationDate, minCreationDate, name, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
String *authors = authors_example; //  (optional) (default to null)
String *category = category_example; //  (optional) (default to null)
String *description = description_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *ownerUsername = ownerUsername_example; //  (optional) (default to null)

[apiInstance pipelinesSearchListWith:authors
    category:category
    description:description
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    name:name
    offset:offset
    ownerUsername:ownerUsername
              completionHandler: ^(PaginatedPipelineList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var opts = {
  'authors': authors_example, // {String} 
  'category': category_example, // {String} 
  'description': description_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'name': name_example, // {String} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'ownerUsername': ownerUsername_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var authors = authors_example;  // String |  (optional)  (default to null)
            var category = category_example;  // String |  (optional)  (default to null)
            var description = description_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var ownerUsername = ownerUsername_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPipelineList result = apiInstance.pipelinesSearchList(authors, category, description, id, limit, maxCreationDate, minCreationDate, name, offset, ownerUsername);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$authors = authors_example; // String | 
$category = category_example; // String | 
$description = description_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$name = name_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.
$ownerUsername = ownerUsername_example; // String | 

try {
    $result = $api_instance->pipelinesSearchList($authors, $category, $description, $id, $limit, $maxCreationDate, $minCreationDate, $name, $offset, $ownerUsername);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $authors = authors_example; # String | 
my $category = category_example; # String | 
my $description = description_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $name = name_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $ownerUsername = ownerUsername_example; # String | 

eval {
    my $result = $api_instance->pipelinesSearchList(authors => $authors, category => $category, description => $description, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, name => $name, offset => $offset, ownerUsername => $ownerUsername);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
authors = authors_example # String |  (optional) (default to null)
category = category_example # String |  (optional) (default to null)
description = description_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
name = name_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
ownerUsername = ownerUsername_example # String |  (optional) (default to null)

try:
    api_response = api_instance.pipelines_search_list(authors=authors, category=category, description=description, id=id, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, name=name, offset=offset, ownerUsername=ownerUsername)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesSearchList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let authors = authors_example; // String
    let category = category_example; // String
    let description = description_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let name = name_example; // String
    let offset = 56; // Integer
    let ownerUsername = ownerUsername_example; // String

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesSearchList(authors, category, description, id, limit, maxCreationDate, minCreationDate, name, offset, ownerUsername, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
authors
String
category
String
description
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
name
String
offset
Integer
The initial index from which to return the results.
owner_username
String

Responses


pipelinesSourcefiles.Retrieve

Overriden to be able to make a GET request to an actual file resource.


/api/v1/pipelines/sourcefiles/{id}/.

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: */*" \
 "http://localhost/api/v1/pipelines/sourcefiles/{id}/."
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.pipelinesSourcefiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefiles.Retrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 

try {
    final result = await api_instance.pipelinesSourcefiles.Retrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesSourcefiles.Retrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.pipelinesSourcefiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefiles.Retrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
String *id = id_example; //  (default to null)

[apiInstance pipelinesSourcefiles.RetrieveWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = id_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesSourcefiles.Retrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesSourcefiles.RetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = id_example;  // String |  (default to null)

            try {
                File result = apiInstance.pipelinesSourcefiles.Retrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesSourcefiles.Retrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = id_example; // String | 

try {
    $result = $api_instance->pipelinesSourcefiles.Retrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesSourcefiles.Retrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = id_example; # String | 

eval {
    my $result = $api_instance->pipelinesSourcefiles.Retrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesSourcefiles.Retrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = id_example # String |  (default to null)

try:
    api_response = api_instance.pipelines_sourcefiles/retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesSourcefiles.Retrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = id_example; // String

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesSourcefiles.Retrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses


pipelinesSourcefilesCreate

A view for the collection of pipeline source files.


/api/v1/pipelines/sourcefiles/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/sourcefiles/" \
 -d '{
  "fname" : "",
  "public" : true,
  "type" : "type"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        PipelineSourceFileRequest pipelineSourceFileRequest = ; // PipelineSourceFileRequest | 

        try {
            PipelineSourceFile result = apiInstance.pipelinesSourcefilesCreate(pipelineSourceFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PipelineSourceFileRequest pipelineSourceFileRequest = new PipelineSourceFileRequest(); // PipelineSourceFileRequest | 

try {
    final result = await api_instance.pipelinesSourcefilesCreate(pipelineSourceFileRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesSourcefilesCreate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        PipelineSourceFileRequest pipelineSourceFileRequest = ; // PipelineSourceFileRequest | 

        try {
            PipelineSourceFile result = apiInstance.pipelinesSourcefilesCreate(pipelineSourceFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
PipelineSourceFileRequest *pipelineSourceFileRequest = ; // 

[apiInstance pipelinesSourcefilesCreateWith:pipelineSourceFileRequest
              completionHandler: ^(PipelineSourceFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var pipelineSourceFileRequest = ; // {PipelineSourceFileRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesSourcefilesCreate(pipelineSourceFileRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesSourcefilesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var pipelineSourceFileRequest = new PipelineSourceFileRequest(); // PipelineSourceFileRequest | 

            try {
                PipelineSourceFile result = apiInstance.pipelinesSourcefilesCreate(pipelineSourceFileRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesSourcefilesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$pipelineSourceFileRequest = ; // PipelineSourceFileRequest | 

try {
    $result = $api_instance->pipelinesSourcefilesCreate($pipelineSourceFileRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesSourcefilesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $pipelineSourceFileRequest = WWW::OPenAPIClient::Object::PipelineSourceFileRequest->new(); # PipelineSourceFileRequest | 

eval {
    my $result = $api_instance->pipelinesSourcefilesCreate(pipelineSourceFileRequest => $pipelineSourceFileRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesSourcefilesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
pipelineSourceFileRequest =  # PipelineSourceFileRequest | 

try:
    api_response = api_instance.pipelines_sourcefiles_create(pipelineSourceFileRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesSourcefilesCreate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let pipelineSourceFileRequest = ; // PipelineSourceFileRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesSourcefilesCreate(pipelineSourceFileRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
pipelineSourceFileRequest *

Responses


pipelinesSourcefilesList

A view for the collection of pipeline source files.


/api/v1/pipelines/sourcefiles/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/sourcefiles/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPipelineSourceFileList result = apiInstance.pipelinesSourcefilesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pipelinesSourcefilesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesSourcefilesList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPipelineSourceFileList result = apiInstance.pipelinesSourcefilesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pipelinesSourcefilesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPipelineSourceFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesSourcefilesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesSourcefilesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPipelineSourceFileList result = apiInstance.pipelinesSourcefilesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesSourcefilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pipelinesSourcefilesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesSourcefilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pipelinesSourcefilesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesSourcefilesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pipelines_sourcefiles_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesSourcefilesList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesSourcefilesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesSourcefilesRetrieve

A pipeline source file view.


/api/v1/pipelines/sourcefiles/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/sourcefiles/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            PipelineSourceFile result = apiInstance.pipelinesSourcefilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesSourcefilesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesSourcefilesRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            PipelineSourceFile result = apiInstance.pipelinesSourcefilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesSourcefilesRetrieveWith:id
              completionHandler: ^(PipelineSourceFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesSourcefilesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesSourcefilesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PipelineSourceFile result = apiInstance.pipelinesSourcefilesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesSourcefilesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesSourcefilesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesSourcefilesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesSourcefilesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesSourcefilesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_sourcefiles_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesSourcefilesRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesSourcefilesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesSourcefilesSearchList

A view for the collection of pipeline source files resulting from a query search.


/api/v1/pipelines/sourcefiles/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/sourcefiles/search/?fname=fname_example&fname_exact=fnameExact_example&fname_icontains=fnameIcontains_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&offset=56&pipeline_id=pipelineId_example&pipeline_name=pipelineName_example&uploader_username=uploaderUsername_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        String fname = fname_example; // String | 
        String fnameExact = fnameExact_example; // String | 
        String fnameIcontains = fnameIcontains_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String pipelineId = pipelineId_example; // String | 
        String pipelineName = pipelineName_example; // String | 
        String uploaderUsername = uploaderUsername_example; // String | 

        try {
            PaginatedPipelineSourceFileList result = apiInstance.pipelinesSourcefilesSearchList(fname, fnameExact, fnameIcontains, id, limit, maxCreationDate, minCreationDate, offset, pipelineId, pipelineName, uploaderUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String fname = new String(); // String | 
final String fnameExact = new String(); // String | 
final String fnameIcontains = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String pipelineId = new String(); // String | 
final String pipelineName = new String(); // String | 
final String uploaderUsername = new String(); // String | 

try {
    final result = await api_instance.pipelinesSourcefilesSearchList(fname, fnameExact, fnameIcontains, id, limit, maxCreationDate, minCreationDate, offset, pipelineId, pipelineName, uploaderUsername);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesSourcefilesSearchList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        String fname = fname_example; // String | 
        String fnameExact = fnameExact_example; // String | 
        String fnameIcontains = fnameIcontains_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String pipelineId = pipelineId_example; // String | 
        String pipelineName = pipelineName_example; // String | 
        String uploaderUsername = uploaderUsername_example; // String | 

        try {
            PaginatedPipelineSourceFileList result = apiInstance.pipelinesSourcefilesSearchList(fname, fnameExact, fnameIcontains, id, limit, maxCreationDate, minCreationDate, offset, pipelineId, pipelineName, uploaderUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesSourcefilesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
String *fname = fname_example; //  (optional) (default to null)
String *fnameExact = fnameExact_example; //  (optional) (default to null)
String *fnameIcontains = fnameIcontains_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *pipelineId = pipelineId_example; //  (optional) (default to null)
String *pipelineName = pipelineName_example; //  (optional) (default to null)
String *uploaderUsername = uploaderUsername_example; //  (optional) (default to null)

[apiInstance pipelinesSourcefilesSearchListWith:fname
    fnameExact:fnameExact
    fnameIcontains:fnameIcontains
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    offset:offset
    pipelineId:pipelineId
    pipelineName:pipelineName
    uploaderUsername:uploaderUsername
              completionHandler: ^(PaginatedPipelineSourceFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var opts = {
  'fname': fname_example, // {String} 
  'fnameExact': fnameExact_example, // {String} 
  'fnameIcontains': fnameIcontains_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'pipelineId': pipelineId_example, // {String} 
  'pipelineName': pipelineName_example, // {String} 
  'uploaderUsername': uploaderUsername_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesSourcefilesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesSourcefilesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var fname = fname_example;  // String |  (optional)  (default to null)
            var fnameExact = fnameExact_example;  // String |  (optional)  (default to null)
            var fnameIcontains = fnameIcontains_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var pipelineId = pipelineId_example;  // String |  (optional)  (default to null)
            var pipelineName = pipelineName_example;  // String |  (optional)  (default to null)
            var uploaderUsername = uploaderUsername_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPipelineSourceFileList result = apiInstance.pipelinesSourcefilesSearchList(fname, fnameExact, fnameIcontains, id, limit, maxCreationDate, minCreationDate, offset, pipelineId, pipelineName, uploaderUsername);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesSourcefilesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$fname = fname_example; // String | 
$fnameExact = fnameExact_example; // String | 
$fnameIcontains = fnameIcontains_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | The initial index from which to return the results.
$pipelineId = pipelineId_example; // String | 
$pipelineName = pipelineName_example; // String | 
$uploaderUsername = uploaderUsername_example; // String | 

try {
    $result = $api_instance->pipelinesSourcefilesSearchList($fname, $fnameExact, $fnameIcontains, $id, $limit, $maxCreationDate, $minCreationDate, $offset, $pipelineId, $pipelineName, $uploaderUsername);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesSourcefilesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $fname = fname_example; # String | 
my $fnameExact = fnameExact_example; # String | 
my $fnameIcontains = fnameIcontains_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $pipelineId = pipelineId_example; # String | 
my $pipelineName = pipelineName_example; # String | 
my $uploaderUsername = uploaderUsername_example; # String | 

eval {
    my $result = $api_instance->pipelinesSourcefilesSearchList(fname => $fname, fnameExact => $fnameExact, fnameIcontains => $fnameIcontains, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, offset => $offset, pipelineId => $pipelineId, pipelineName => $pipelineName, uploaderUsername => $uploaderUsername);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesSourcefilesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
fname = fname_example # String |  (optional) (default to null)
fnameExact = fnameExact_example # String |  (optional) (default to null)
fnameIcontains = fnameIcontains_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
pipelineId = pipelineId_example # String |  (optional) (default to null)
pipelineName = pipelineName_example # String |  (optional) (default to null)
uploaderUsername = uploaderUsername_example # String |  (optional) (default to null)

try:
    api_response = api_instance.pipelines_sourcefiles_search_list(fname=fname, fnameExact=fnameExact, fnameIcontains=fnameIcontains, id=id, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, offset=offset, pipelineId=pipelineId, pipelineName=pipelineName, uploaderUsername=uploaderUsername)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesSourcefilesSearchList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let fname = fname_example; // String
    let fnameExact = fnameExact_example; // String
    let fnameIcontains = fnameIcontains_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let offset = 56; // Integer
    let pipelineId = pipelineId_example; // String
    let pipelineName = pipelineName_example; // String
    let uploaderUsername = uploaderUsername_example; // String

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesSourcefilesSearchList(fname, fnameExact, fnameIcontains, id, limit, maxCreationDate, minCreationDate, offset, pipelineId, pipelineName, uploaderUsername, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
fname
String
fname_exact
String
fname_icontains
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
offset
Integer
The initial index from which to return the results.
pipeline_id
String
pipeline_name
String
uploader_username
String

Responses


pipelinesStringParameterRetrieve

A view for a string default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/string-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/string-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingStrParameter result = apiInstance.pipelinesStringParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesStringParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesStringParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesStringParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            DefaultPipingStrParameter result = apiInstance.pipelinesStringParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesStringParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesStringParameterRetrieveWith:id
              completionHandler: ^(DefaultPipingStrParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesStringParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesStringParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                DefaultPipingStrParameter result = apiInstance.pipelinesStringParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesStringParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesStringParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesStringParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesStringParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesStringParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_string_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesStringParameterRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesStringParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesStringParameterUpdate

A view for a string default value for a plugin parameter in a pipeline's plugin piping.


/api/v1/pipelines/string-parameter/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/string-parameter/{id}/" \
 -d '{
  "value" : "value"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingStrParameterRequest defaultPipingStrParameterRequest = ; // DefaultPipingStrParameterRequest | 

        try {
            DefaultPipingStrParameter result = apiInstance.pipelinesStringParameterUpdate(id, defaultPipingStrParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesStringParameterUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final DefaultPipingStrParameterRequest defaultPipingStrParameterRequest = new DefaultPipingStrParameterRequest(); // DefaultPipingStrParameterRequest | 

try {
    final result = await api_instance.pipelinesStringParameterUpdate(id, defaultPipingStrParameterRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesStringParameterUpdate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        DefaultPipingStrParameterRequest defaultPipingStrParameterRequest = ; // DefaultPipingStrParameterRequest | 

        try {
            DefaultPipingStrParameter result = apiInstance.pipelinesStringParameterUpdate(id, defaultPipingStrParameterRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesStringParameterUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
DefaultPipingStrParameterRequest *defaultPipingStrParameterRequest = ; //  (optional)

[apiInstance pipelinesStringParameterUpdateWith:id
    defaultPipingStrParameterRequest:defaultPipingStrParameterRequest
              completionHandler: ^(DefaultPipingStrParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'defaultPipingStrParameterRequest':  // {DefaultPipingStrParameterRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesStringParameterUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesStringParameterUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var defaultPipingStrParameterRequest = new DefaultPipingStrParameterRequest(); // DefaultPipingStrParameterRequest |  (optional) 

            try {
                DefaultPipingStrParameter result = apiInstance.pipelinesStringParameterUpdate(id, defaultPipingStrParameterRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesStringParameterUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$defaultPipingStrParameterRequest = ; // DefaultPipingStrParameterRequest | 

try {
    $result = $api_instance->pipelinesStringParameterUpdate($id, $defaultPipingStrParameterRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesStringParameterUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $defaultPipingStrParameterRequest = WWW::OPenAPIClient::Object::DefaultPipingStrParameterRequest->new(); # DefaultPipingStrParameterRequest | 

eval {
    my $result = $api_instance->pipelinesStringParameterUpdate(id => $id, defaultPipingStrParameterRequest => $defaultPipingStrParameterRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesStringParameterUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
defaultPipingStrParameterRequest =  # DefaultPipingStrParameterRequest |  (optional)

try:
    api_response = api_instance.pipelines_string_parameter_update(id, defaultPipingStrParameterRequest=defaultPipingStrParameterRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesStringParameterUpdate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let defaultPipingStrParameterRequest = ; // DefaultPipingStrParameterRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesStringParameterUpdate(id, defaultPipingStrParameterRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
defaultPipingStrParameterRequest

Responses


pipelinesUpdate

A pipeline view.


/api/v1/pipelines/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/{id}/" \
 -d '{
  "plugin_inst_id" : 1,
  "plugin_tree" : "",
  "name" : "name",
  "description" : "description",
  "locked" : true,
  "category" : "category",
  "authors" : "authors"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        PipelineRequest pipelineRequest = ; // PipelineRequest | 

        try {
            Pipeline result = apiInstance.pipelinesUpdate(id, pipelineRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final PipelineRequest pipelineRequest = new PipelineRequest(); // PipelineRequest | 

try {
    final result = await api_instance.pipelinesUpdate(id, pipelineRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesUpdate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        PipelineRequest pipelineRequest = ; // PipelineRequest | 

        try {
            Pipeline result = apiInstance.pipelinesUpdate(id, pipelineRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
PipelineRequest *pipelineRequest = ; // 

[apiInstance pipelinesUpdateWith:id
    pipelineRequest:pipelineRequest
              completionHandler: ^(Pipeline output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var pipelineRequest = ; // {PipelineRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesUpdate(id, pipelineRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var pipelineRequest = new PipelineRequest(); // PipelineRequest | 

            try {
                Pipeline result = apiInstance.pipelinesUpdate(id, pipelineRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$pipelineRequest = ; // PipelineRequest | 

try {
    $result = $api_instance->pipelinesUpdate($id, $pipelineRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $pipelineRequest = WWW::OPenAPIClient::Object::PipelineRequest->new(); # PipelineRequest | 

eval {
    my $result = $api_instance->pipelinesUpdate(id => $id, pipelineRequest => $pipelineRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
pipelineRequest =  # PipelineRequest | 

try:
    api_response = api_instance.pipelines_update(id, pipelineRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesUpdate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let pipelineRequest = ; // PipelineRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesUpdate(id, pipelineRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pipelineRequest *

Responses


pipelinesWorkflowsCreate

A view for the collection of pipeline-specific workflows.


/api/v1/pipelines/{id}/workflows/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/{id}/workflows/" \
 -d '{
  "previous_plugin_inst_id" : 1,
  "nodes_info" : "",
  "title" : "title"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        WorkflowRequest workflowRequest = ; // WorkflowRequest | 

        try {
            Workflow result = apiInstance.pipelinesWorkflowsCreate(id, workflowRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final WorkflowRequest workflowRequest = new WorkflowRequest(); // WorkflowRequest | 

try {
    final result = await api_instance.pipelinesWorkflowsCreate(id, workflowRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesWorkflowsCreate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        WorkflowRequest workflowRequest = ; // WorkflowRequest | 

        try {
            Workflow result = apiInstance.pipelinesWorkflowsCreate(id, workflowRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
WorkflowRequest *workflowRequest = ; //  (optional)

[apiInstance pipelinesWorkflowsCreateWith:id
    workflowRequest:workflowRequest
              completionHandler: ^(Workflow output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'workflowRequest':  // {WorkflowRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesWorkflowsCreate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesWorkflowsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var workflowRequest = new WorkflowRequest(); // WorkflowRequest |  (optional) 

            try {
                Workflow result = apiInstance.pipelinesWorkflowsCreate(id, workflowRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesWorkflowsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$workflowRequest = ; // WorkflowRequest | 

try {
    $result = $api_instance->pipelinesWorkflowsCreate($id, $workflowRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesWorkflowsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $workflowRequest = WWW::OPenAPIClient::Object::WorkflowRequest->new(); # WorkflowRequest | 

eval {
    my $result = $api_instance->pipelinesWorkflowsCreate(id => $id, workflowRequest => $workflowRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesWorkflowsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
workflowRequest =  # WorkflowRequest |  (optional)

try:
    api_response = api_instance.pipelines_workflows_create(id, workflowRequest=workflowRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesWorkflowsCreate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let workflowRequest = ; // WorkflowRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesWorkflowsCreate(id, workflowRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
workflowRequest

Responses


pipelinesWorkflowsDestroy

A workflow view.


/api/v1/pipelines/workflows/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/pipelines/workflows/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pipelinesWorkflowsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesWorkflowsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesWorkflowsDestroy: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pipelinesWorkflowsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesWorkflowsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pipelinesWorkflowsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesWorkflowsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.pipelinesWorkflowsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesWorkflowsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $api_instance->pipelinesWorkflowsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesWorkflowsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->pipelinesWorkflowsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesWorkflowsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.pipelines_workflows_destroy(id)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesWorkflowsDestroy: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesWorkflowsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesWorkflowsPlugininstancesList

A view for the collection of plugin instances that compose the workflow.


/api/v1/pipelines/workflows/{id}/plugininstances/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/workflows/{id}/plugininstances/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.pipelinesWorkflowsPlugininstancesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsPlugininstancesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pipelinesWorkflowsPlugininstancesList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesWorkflowsPlugininstancesList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.pipelinesWorkflowsPlugininstancesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsPlugininstancesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pipelinesWorkflowsPlugininstancesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginInstanceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesWorkflowsPlugininstancesList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesWorkflowsPlugininstancesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginInstanceList result = apiInstance.pipelinesWorkflowsPlugininstancesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesWorkflowsPlugininstancesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pipelinesWorkflowsPlugininstancesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesWorkflowsPlugininstancesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pipelinesWorkflowsPlugininstancesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesWorkflowsPlugininstancesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.pipelines_workflows_plugininstances_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesWorkflowsPlugininstancesList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesWorkflowsPlugininstancesList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pipelinesWorkflowsRetrieve

A workflow view.


/api/v1/pipelines/workflows/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/workflows/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            Workflow result = apiInstance.pipelinesWorkflowsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pipelinesWorkflowsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesWorkflowsRetrieve: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 

        try {
            Workflow result = apiInstance.pipelinesWorkflowsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pipelinesWorkflowsRetrieveWith:id
              completionHandler: ^(Workflow output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
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.pipelinesWorkflowsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesWorkflowsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Workflow result = apiInstance.pipelinesWorkflowsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesWorkflowsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pipelinesWorkflowsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesWorkflowsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pipelinesWorkflowsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesWorkflowsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.pipelines_workflows_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesWorkflowsRetrieve: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesWorkflowsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pipelinesWorkflowsSearchList

A view for the collection of workflows resulting from a query search.


/api/v1/pipelines/workflows/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/workflows/search/?id=56&limit=56&offset=56&owner_username=ownerUsername_example&pipeline_name=pipelineName_example&title=title_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 
        String pipelineName = pipelineName_example; // String | 
        String title = title_example; // String | 

        try {
            PaginatedWorkflowList result = apiInstance.pipelinesWorkflowsSearchList(id, limit, offset, ownerUsername, pipelineName, title);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String ownerUsername = new String(); // String | 
final String pipelineName = new String(); // String | 
final String title = new String(); // String | 

try {
    final result = await api_instance.pipelinesWorkflowsSearchList(id, limit, offset, ownerUsername, pipelineName, title);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesWorkflowsSearchList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 
        String pipelineName = pipelineName_example; // String | 
        String title = title_example; // String | 

        try {
            PaginatedWorkflowList result = apiInstance.pipelinesWorkflowsSearchList(id, limit, offset, ownerUsername, pipelineName, title);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *ownerUsername = ownerUsername_example; //  (optional) (default to null)
String *pipelineName = pipelineName_example; //  (optional) (default to null)
String *title = title_example; //  (optional) (default to null)

[apiInstance pipelinesWorkflowsSearchListWith:id
    limit:limit
    offset:offset
    ownerUsername:ownerUsername
    pipelineName:pipelineName
    title:title
              completionHandler: ^(PaginatedWorkflowList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var opts = {
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56, // {Integer} The initial index from which to return the results.
  'ownerUsername': ownerUsername_example, // {String} 
  'pipelineName': pipelineName_example, // {String} 
  'title': title_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesWorkflowsSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesWorkflowsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var ownerUsername = ownerUsername_example;  // String |  (optional)  (default to null)
            var pipelineName = pipelineName_example;  // String |  (optional)  (default to null)
            var title = title_example;  // String |  (optional)  (default to null)

            try {
                PaginatedWorkflowList result = apiInstance.pipelinesWorkflowsSearchList(id, limit, offset, ownerUsername, pipelineName, title);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesWorkflowsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.
$ownerUsername = ownerUsername_example; // String | 
$pipelineName = pipelineName_example; // String | 
$title = title_example; // String | 

try {
    $result = $api_instance->pipelinesWorkflowsSearchList($id, $limit, $offset, $ownerUsername, $pipelineName, $title);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesWorkflowsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.
my $ownerUsername = ownerUsername_example; # String | 
my $pipelineName = pipelineName_example; # String | 
my $title = title_example; # String | 

eval {
    my $result = $api_instance->pipelinesWorkflowsSearchList(id => $id, limit => $limit, offset => $offset, ownerUsername => $ownerUsername, pipelineName => $pipelineName, title => $title);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesWorkflowsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
ownerUsername = ownerUsername_example # String |  (optional) (default to null)
pipelineName = pipelineName_example # String |  (optional) (default to null)
title = title_example # String |  (optional) (default to null)

try:
    api_response = api_instance.pipelines_workflows_search_list(id=id, limit=limit, offset=offset, ownerUsername=ownerUsername, pipelineName=pipelineName, title=title)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesWorkflowsSearchList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer
    let ownerUsername = ownerUsername_example; // String
    let pipelineName = pipelineName_example; // String
    let title = title_example; // String

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesWorkflowsSearchList(id, limit, offset, ownerUsername, pipelineName, title, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.
owner_username
String
pipeline_name
String
title
String

Responses


pipelinesWorkflowsUpdate

A workflow view.


/api/v1/pipelines/workflows/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/pipelines/workflows/{id}/" \
 -d '{
  "previous_plugin_inst_id" : 1,
  "nodes_info" : "",
  "title" : "title"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        WorkflowRequest workflowRequest = ; // WorkflowRequest | 

        try {
            Workflow result = apiInstance.pipelinesWorkflowsUpdate(id, workflowRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final WorkflowRequest workflowRequest = new WorkflowRequest(); // WorkflowRequest | 

try {
    final result = await api_instance.pipelinesWorkflowsUpdate(id, workflowRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pipelinesWorkflowsUpdate: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        WorkflowRequest workflowRequest = ; // WorkflowRequest | 

        try {
            Workflow result = apiInstance.pipelinesWorkflowsUpdate(id, workflowRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#pipelinesWorkflowsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
WorkflowRequest *workflowRequest = ; //  (optional)

[apiInstance pipelinesWorkflowsUpdateWith:id
    workflowRequest:workflowRequest
              completionHandler: ^(Workflow output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'workflowRequest':  // {WorkflowRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pipelinesWorkflowsUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pipelinesWorkflowsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var workflowRequest = new WorkflowRequest(); // WorkflowRequest |  (optional) 

            try {
                Workflow result = apiInstance.pipelinesWorkflowsUpdate(id, workflowRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.pipelinesWorkflowsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$workflowRequest = ; // WorkflowRequest | 

try {
    $result = $api_instance->pipelinesWorkflowsUpdate($id, $workflowRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->pipelinesWorkflowsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $workflowRequest = WWW::OPenAPIClient::Object::WorkflowRequest->new(); # WorkflowRequest | 

eval {
    my $result = $api_instance->pipelinesWorkflowsUpdate(id => $id, workflowRequest => $workflowRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->pipelinesWorkflowsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
workflowRequest =  # WorkflowRequest |  (optional)

try:
    api_response = api_instance.pipelines_workflows_update(id, workflowRequest=workflowRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->pipelinesWorkflowsUpdate: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let workflowRequest = ; // WorkflowRequest

    let mut context = PipelinesApi::Context::default();
    let result = client.pipelinesWorkflowsUpdate(id, workflowRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
workflowRequest

Responses


workflowsList

A view for the collection of pipeline-specific workflows.


/api/v1/pipelines/{id}/workflows/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/pipelines/{id}/workflows/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PipelinesApi;

import java.io.File;
import java.util.*;

public class PipelinesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedWorkflowList result = apiInstance.workflowsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#workflowsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.workflowsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->workflowsList: $e\n');
}

import org.openapitools.client.api.PipelinesApi;

public class PipelinesApiExample {
    public static void main(String[] args) {
        PipelinesApi apiInstance = new PipelinesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedWorkflowList result = apiInstance.workflowsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelinesApi#workflowsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PipelinesApi *apiInstance = [[PipelinesApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance workflowsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedWorkflowList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PipelinesApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.workflowsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class workflowsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PipelinesApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedWorkflowList result = apiInstance.workflowsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PipelinesApi.workflowsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PipelinesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->workflowsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->workflowsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PipelinesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PipelinesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->workflowsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelinesApi->workflowsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PipelinesApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.workflows_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelinesApi->workflowsList: %s\n" % e)
extern crate PipelinesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PipelinesApi::Context::default();
    let result = client.workflowsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


Plugininstances

plugininstancesList

A view for the collection of feed-specific plugin instances.


/api/v1/{id}/plugininstances/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/plugininstances/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PlugininstancesApi;

import java.io.File;
import java.util.*;

public class PlugininstancesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PlugininstancesApi apiInstance = new PlugininstancesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.plugininstancesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlugininstancesApi#plugininstancesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.plugininstancesList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->plugininstancesList: $e\n');
}

import org.openapitools.client.api.PlugininstancesApi;

public class PlugininstancesApiExample {
    public static void main(String[] args) {
        PlugininstancesApi apiInstance = new PlugininstancesApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.plugininstancesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlugininstancesApi#plugininstancesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PlugininstancesApi *apiInstance = [[PlugininstancesApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance plugininstancesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginInstanceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PlugininstancesApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.plugininstancesList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class plugininstancesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PlugininstancesApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginInstanceList result = apiInstance.plugininstancesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PlugininstancesApi.plugininstancesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PlugininstancesApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->plugininstancesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlugininstancesApi->plugininstancesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PlugininstancesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PlugininstancesApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->plugininstancesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlugininstancesApi->plugininstancesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PlugininstancesApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugininstances_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlugininstancesApi->plugininstancesList: %s\n" % e)
extern crate PlugininstancesApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PlugininstancesApi::Context::default();
    let result = client.plugininstancesList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


Plugins

allPluginsInstancesList

A view for the collection of all plugin instances.


/api/v1/plugins/instances/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.allPluginsInstancesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#allPluginsInstancesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.allPluginsInstancesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->allPluginsInstancesList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.allPluginsInstancesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#allPluginsInstancesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance allPluginsInstancesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPluginInstanceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allPluginsInstancesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class allPluginsInstancesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginInstanceList result = apiInstance.allPluginsInstancesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.allPluginsInstancesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->allPluginsInstancesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->allPluginsInstancesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->allPluginsInstancesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->allPluginsInstancesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.all_plugins_instances_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->allPluginsInstancesList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.allPluginsInstancesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsBooleanParameterRetrieve

A boolean parameter view.


/api/v1/plugins/boolean-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/boolean-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            BoolParameter result = apiInstance.pluginsBooleanParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsBooleanParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsBooleanParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsBooleanParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            BoolParameter result = apiInstance.pluginsBooleanParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsBooleanParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsBooleanParameterRetrieveWith:id
              completionHandler: ^(BoolParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsBooleanParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsBooleanParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                BoolParameter result = apiInstance.pluginsBooleanParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsBooleanParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsBooleanParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsBooleanParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsBooleanParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsBooleanParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_boolean_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsBooleanParameterRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsBooleanParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsComputeresourcesList

A view for a plugin-specific collection of compute resources.


/api/v1/plugins/{id}/computeresources/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/{id}/computeresources/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedComputeResourceList result = apiInstance.pluginsComputeresourcesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsComputeresourcesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsComputeresourcesList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsComputeresourcesList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedComputeResourceList result = apiInstance.pluginsComputeresourcesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsComputeresourcesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsComputeresourcesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedComputeResourceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsComputeresourcesList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsComputeresourcesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedComputeResourceList result = apiInstance.pluginsComputeresourcesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsComputeresourcesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsComputeresourcesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsComputeresourcesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsComputeresourcesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsComputeresourcesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_computeresources_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsComputeresourcesList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsComputeresourcesList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsFloatParameterRetrieve

A float parameter view.


/api/v1/plugins/float-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/float-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            FloatParameter result = apiInstance.pluginsFloatParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsFloatParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsFloatParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsFloatParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            FloatParameter result = apiInstance.pluginsFloatParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsFloatParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsFloatParameterRetrieveWith:id
              completionHandler: ^(FloatParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsFloatParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsFloatParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                FloatParameter result = apiInstance.pluginsFloatParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsFloatParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsFloatParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsFloatParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsFloatParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsFloatParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_float_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsFloatParameterRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsFloatParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsInstancesCreate

A view for the collection of plugin instances.


/api/v1/plugins/{id}/instances/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/plugins/{id}/instances/" \
 -d '{
  "cpu_limit" : 0,
  "previous_id" : 1210617418,
  "number_of_workers" : -1517921766,
  "memory_limit" : 6,
  "title" : "title",
  "gpu_limit" : 413233370,
  "compute_resource_name" : "compute_resource_name",
  "status" : "created"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        PluginInstanceRequest pluginInstanceRequest = ; // PluginInstanceRequest | 

        try {
            PluginInstance result = apiInstance.pluginsInstancesCreate(id, pluginInstanceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final PluginInstanceRequest pluginInstanceRequest = new PluginInstanceRequest(); // PluginInstanceRequest | 

try {
    final result = await api_instance.pluginsInstancesCreate(id, pluginInstanceRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesCreate: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        PluginInstanceRequest pluginInstanceRequest = ; // PluginInstanceRequest | 

        try {
            PluginInstance result = apiInstance.pluginsInstancesCreate(id, pluginInstanceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
PluginInstanceRequest *pluginInstanceRequest = ; //  (optional)

[apiInstance pluginsInstancesCreateWith:id
    pluginInstanceRequest:pluginInstanceRequest
              completionHandler: ^(PluginInstance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'pluginInstanceRequest':  // {PluginInstanceRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesCreate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var pluginInstanceRequest = new PluginInstanceRequest(); // PluginInstanceRequest |  (optional) 

            try {
                PluginInstance result = apiInstance.pluginsInstancesCreate(id, pluginInstanceRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$pluginInstanceRequest = ; // PluginInstanceRequest | 

try {
    $result = $api_instance->pluginsInstancesCreate($id, $pluginInstanceRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $pluginInstanceRequest = WWW::OPenAPIClient::Object::PluginInstanceRequest->new(); # PluginInstanceRequest | 

eval {
    my $result = $api_instance->pluginsInstancesCreate(id => $id, pluginInstanceRequest => $pluginInstanceRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
pluginInstanceRequest =  # PluginInstanceRequest |  (optional)

try:
    api_response = api_instance.plugins_instances_create(id, pluginInstanceRequest=pluginInstanceRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesCreate: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let pluginInstanceRequest = ; // PluginInstanceRequest

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesCreate(id, pluginInstanceRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pluginInstanceRequest

Responses


pluginsInstancesDescendantsList

A view for the collection of plugin instances that are a descendant of this plugin instance.


/api/v1/plugins/instances/{id}/descendants/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/{id}/descendants/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.pluginsInstancesDescendantsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesDescendantsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsInstancesDescendantsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesDescendantsList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.pluginsInstancesDescendantsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesDescendantsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsInstancesDescendantsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginInstanceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesDescendantsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesDescendantsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginInstanceList result = apiInstance.pluginsInstancesDescendantsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesDescendantsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsInstancesDescendantsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesDescendantsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsInstancesDescendantsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesDescendantsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_instances_descendants_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesDescendantsList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesDescendantsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsInstancesDestroy

A plugin instance view.


/api/v1/plugins/instances/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/plugins/instances/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pluginsInstancesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsInstancesDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesDestroy: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.pluginsInstancesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsInstancesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pluginsInstancesDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.pluginsInstancesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $api_instance->pluginsInstancesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->pluginsInstancesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.plugins_instances_destroy(id)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesDestroy: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsInstancesList

A view for the collection of plugin instances.


/api/v1/plugins/{id}/instances/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/{id}/instances/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.pluginsInstancesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsInstancesList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceList result = apiInstance.pluginsInstancesList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsInstancesListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginInstanceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginInstanceList result = apiInstance.pluginsInstancesList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsInstancesList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsInstancesList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_instances_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsInstancesParametersList

A view for the collection of parameters that the plugin instance was run with.


/api/v1/plugins/instances/{id}/parameters/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/{id}/parameters/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGenericParameterList result = apiInstance.pluginsInstancesParametersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesParametersList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsInstancesParametersList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesParametersList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGenericParameterList result = apiInstance.pluginsInstancesParametersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesParametersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsInstancesParametersListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedGenericParameterList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesParametersList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesParametersListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedGenericParameterList result = apiInstance.pluginsInstancesParametersList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesParametersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsInstancesParametersList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesParametersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsInstancesParametersList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesParametersList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_instances_parameters_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesParametersList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesParametersList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsInstancesRetrieve

A plugin instance view.


/api/v1/plugins/instances/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginInstance result = apiInstance.pluginsInstancesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsInstancesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginInstance result = apiInstance.pluginsInstancesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsInstancesRetrieveWith:id
              completionHandler: ^(PluginInstance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsInstancesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PluginInstance result = apiInstance.pluginsInstancesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsInstancesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsInstancesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_instances_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsInstancesSearchList

A view for the collection of plugin instances resulting from a query search.


/api/v1/plugins/instances/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/search/?feed_id=feedId_example&id=56&limit=56&max_end_date=2013-10-20T19:20:30+01:00&max_start_date=2013-10-20T19:20:30+01:00&min_end_date=2013-10-20T19:20:30+01:00&min_start_date=2013-10-20T19:20:30+01:00&offset=56&owner_username=ownerUsername_example&plugin_id=pluginId_example&plugin_name=pluginName_example&plugin_name_exact=pluginNameExact_example&plugin_version=pluginVersion_example&previous_id=previousId_example&root_id=rootId_example&status=status_example&title=title_example&workflow_id=workflowId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        String feedId = feedId_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxEndDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date maxStartDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minEndDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minStartDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 
        String pluginId = pluginId_example; // String | 
        String pluginName = pluginName_example; // String | 
        String pluginNameExact = pluginNameExact_example; // String | 
        String pluginVersion = pluginVersion_example; // String | 
        String previousId = previousId_example; // String | 
        String rootId = rootId_example; // String | 
        String status = status_example; // String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled
        String title = title_example; // String | 
        String workflowId = workflowId_example; // String | 

        try {
            PaginatedPluginInstanceList result = apiInstance.pluginsInstancesSearchList(feedId, id, limit, maxEndDate, maxStartDate, minEndDate, minStartDate, offset, ownerUsername, pluginId, pluginName, pluginNameExact, pluginVersion, previousId, rootId, status, title, workflowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String feedId = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxEndDate = new Date(); // Date | 
final Date maxStartDate = new Date(); // Date | 
final Date minEndDate = new Date(); // Date | 
final Date minStartDate = new Date(); // Date | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String ownerUsername = new String(); // String | 
final String pluginId = new String(); // String | 
final String pluginName = new String(); // String | 
final String pluginNameExact = new String(); // String | 
final String pluginVersion = new String(); // String | 
final String previousId = new String(); // String | 
final String rootId = new String(); // String | 
final String status = new String(); // String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled
final String title = new String(); // String | 
final String workflowId = new String(); // String | 

try {
    final result = await api_instance.pluginsInstancesSearchList(feedId, id, limit, maxEndDate, maxStartDate, minEndDate, minStartDate, offset, ownerUsername, pluginId, pluginName, pluginNameExact, pluginVersion, previousId, rootId, status, title, workflowId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesSearchList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        String feedId = feedId_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxEndDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date maxStartDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minEndDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minStartDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 
        String pluginId = pluginId_example; // String | 
        String pluginName = pluginName_example; // String | 
        String pluginNameExact = pluginNameExact_example; // String | 
        String pluginVersion = pluginVersion_example; // String | 
        String previousId = previousId_example; // String | 
        String rootId = rootId_example; // String | 
        String status = status_example; // String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled
        String title = title_example; // String | 
        String workflowId = workflowId_example; // String | 

        try {
            PaginatedPluginInstanceList result = apiInstance.pluginsInstancesSearchList(feedId, id, limit, maxEndDate, maxStartDate, minEndDate, minStartDate, offset, ownerUsername, pluginId, pluginName, pluginNameExact, pluginVersion, previousId, rootId, status, title, workflowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
String *feedId = feedId_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxEndDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *maxStartDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minEndDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minStartDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *ownerUsername = ownerUsername_example; //  (optional) (default to null)
String *pluginId = pluginId_example; //  (optional) (default to null)
String *pluginName = pluginName_example; //  (optional) (default to null)
String *pluginNameExact = pluginNameExact_example; //  (optional) (default to null)
String *pluginVersion = pluginVersion_example; //  (optional) (default to null)
String *previousId = previousId_example; //  (optional) (default to null)
String *rootId = rootId_example; //  (optional) (default to null)
String *status = status_example; // * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled (optional) (default to null)
String *title = title_example; //  (optional) (default to null)
String *workflowId = workflowId_example; //  (optional) (default to null)

[apiInstance pluginsInstancesSearchListWith:feedId
    id:id
    limit:limit
    maxEndDate:maxEndDate
    maxStartDate:maxStartDate
    minEndDate:minEndDate
    minStartDate:minStartDate
    offset:offset
    ownerUsername:ownerUsername
    pluginId:pluginId
    pluginName:pluginName
    pluginNameExact:pluginNameExact
    pluginVersion:pluginVersion
    previousId:previousId
    rootId:rootId
    status:status
    title:title
    workflowId:workflowId
              completionHandler: ^(PaginatedPluginInstanceList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var opts = {
  'feedId': feedId_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxEndDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'maxStartDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minEndDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minStartDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'ownerUsername': ownerUsername_example, // {String} 
  'pluginId': pluginId_example, // {String} 
  'pluginName': pluginName_example, // {String} 
  'pluginNameExact': pluginNameExact_example, // {String} 
  'pluginVersion': pluginVersion_example, // {String} 
  'previousId': previousId_example, // {String} 
  'rootId': rootId_example, // {String} 
  'status': status_example, // {String} * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled
  'title': title_example, // {String} 
  'workflowId': workflowId_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var feedId = feedId_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxEndDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var maxStartDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minEndDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minStartDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var ownerUsername = ownerUsername_example;  // String |  (optional)  (default to null)
            var pluginId = pluginId_example;  // String |  (optional)  (default to null)
            var pluginName = pluginName_example;  // String |  (optional)  (default to null)
            var pluginNameExact = pluginNameExact_example;  // String |  (optional)  (default to null)
            var pluginVersion = pluginVersion_example;  // String |  (optional)  (default to null)
            var previousId = previousId_example;  // String |  (optional)  (default to null)
            var rootId = rootId_example;  // String |  (optional)  (default to null)
            var status = status_example;  // String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled (optional)  (default to null)
            var title = title_example;  // String |  (optional)  (default to null)
            var workflowId = workflowId_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPluginInstanceList result = apiInstance.pluginsInstancesSearchList(feedId, id, limit, maxEndDate, maxStartDate, minEndDate, minStartDate, offset, ownerUsername, pluginId, pluginName, pluginNameExact, pluginVersion, previousId, rootId, status, title, workflowId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$feedId = feedId_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxEndDate = 2013-10-20T19:20:30+01:00; // Date | 
$maxStartDate = 2013-10-20T19:20:30+01:00; // Date | 
$minEndDate = 2013-10-20T19:20:30+01:00; // Date | 
$minStartDate = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | The initial index from which to return the results.
$ownerUsername = ownerUsername_example; // String | 
$pluginId = pluginId_example; // String | 
$pluginName = pluginName_example; // String | 
$pluginNameExact = pluginNameExact_example; // String | 
$pluginVersion = pluginVersion_example; // String | 
$previousId = previousId_example; // String | 
$rootId = rootId_example; // String | 
$status = status_example; // String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled
$title = title_example; // String | 
$workflowId = workflowId_example; // String | 

try {
    $result = $api_instance->pluginsInstancesSearchList($feedId, $id, $limit, $maxEndDate, $maxStartDate, $minEndDate, $minStartDate, $offset, $ownerUsername, $pluginId, $pluginName, $pluginNameExact, $pluginVersion, $previousId, $rootId, $status, $title, $workflowId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $feedId = feedId_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxEndDate = 2013-10-20T19:20:30+01:00; # Date | 
my $maxStartDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minEndDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minStartDate = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $ownerUsername = ownerUsername_example; # String | 
my $pluginId = pluginId_example; # String | 
my $pluginName = pluginName_example; # String | 
my $pluginNameExact = pluginNameExact_example; # String | 
my $pluginVersion = pluginVersion_example; # String | 
my $previousId = previousId_example; # String | 
my $rootId = rootId_example; # String | 
my $status = status_example; # String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled
my $title = title_example; # String | 
my $workflowId = workflowId_example; # String | 

eval {
    my $result = $api_instance->pluginsInstancesSearchList(feedId => $feedId, id => $id, limit => $limit, maxEndDate => $maxEndDate, maxStartDate => $maxStartDate, minEndDate => $minEndDate, minStartDate => $minStartDate, offset => $offset, ownerUsername => $ownerUsername, pluginId => $pluginId, pluginName => $pluginName, pluginNameExact => $pluginNameExact, pluginVersion => $pluginVersion, previousId => $previousId, rootId => $rootId, status => $status, title => $title, workflowId => $workflowId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
feedId = feedId_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxEndDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
maxStartDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minEndDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minStartDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
ownerUsername = ownerUsername_example # String |  (optional) (default to null)
pluginId = pluginId_example # String |  (optional) (default to null)
pluginName = pluginName_example # String |  (optional) (default to null)
pluginNameExact = pluginNameExact_example # String |  (optional) (default to null)
pluginVersion = pluginVersion_example # String |  (optional) (default to null)
previousId = previousId_example # String |  (optional) (default to null)
rootId = rootId_example # String |  (optional) (default to null)
status = status_example # String | * `created` - Default initial
* `waiting` - Waiting to be scheduled
* `scheduled` - Scheduled on worker
* `started` - Started on compute env
* `registeringFiles` - Registering output files
* `finishedSuccessfully` - Finished successfully
* `finishedWithError` - Finished with error
* `cancelled` - Cancelled (optional) (default to null)
title = title_example # String |  (optional) (default to null)
workflowId = workflowId_example # String |  (optional) (default to null)

try:
    api_response = api_instance.plugins_instances_search_list(feedId=feedId, id=id, limit=limit, maxEndDate=maxEndDate, maxStartDate=maxStartDate, minEndDate=minEndDate, minStartDate=minStartDate, offset=offset, ownerUsername=ownerUsername, pluginId=pluginId, pluginName=pluginName, pluginNameExact=pluginNameExact, pluginVersion=pluginVersion, previousId=previousId, rootId=rootId, status=status, title=title, workflowId=workflowId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesSearchList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let feedId = feedId_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxEndDate = 2013-10-20T19:20:30+01:00; // Date
    let maxStartDate = 2013-10-20T19:20:30+01:00; // Date
    let minEndDate = 2013-10-20T19:20:30+01:00; // Date
    let minStartDate = 2013-10-20T19:20:30+01:00; // Date
    let offset = 56; // Integer
    let ownerUsername = ownerUsername_example; // String
    let pluginId = pluginId_example; // String
    let pluginName = pluginName_example; // String
    let pluginNameExact = pluginNameExact_example; // String
    let pluginVersion = pluginVersion_example; // String
    let previousId = previousId_example; // String
    let rootId = rootId_example; // String
    let status = status_example; // String
    let title = title_example; // String
    let workflowId = workflowId_example; // String

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesSearchList(feedId, id, limit, maxEndDate, maxStartDate, minEndDate, minStartDate, offset, ownerUsername, pluginId, pluginName, pluginNameExact, pluginVersion, previousId, rootId, status, title, workflowId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
feed_id
String
id
Integer
limit
Integer
Number of results to return per page.
max_end_date
Date (date-time)
max_start_date
Date (date-time)
min_end_date
Date (date-time)
min_start_date
Date (date-time)
offset
Integer
The initial index from which to return the results.
owner_username
String
plugin_id
String
plugin_name
String
plugin_name_exact
String
plugin_version
String
previous_id
String
root_id
String
status
String
* `created` - Default initial * `waiting` - Waiting to be scheduled * `scheduled` - Scheduled on worker * `started` - Started on compute env * `registeringFiles` - Registering output files * `finishedSuccessfully` - Finished successfully * `finishedWithError` - Finished with error * `cancelled` - Cancelled
title
String
workflow_id
String

Responses


pluginsInstancesSplitsCreate

A view for the collection of splits for a plugin instance.


/api/v1/plugins/instances/{id}/splits/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/plugins/instances/{id}/splits/" \
 -d '{
  "filter" : "filter",
  "compute_resource_name" : "compute_resource_name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        PluginInstanceSplitRequest pluginInstanceSplitRequest = ; // PluginInstanceSplitRequest | 

        try {
            PluginInstanceSplit result = apiInstance.pluginsInstancesSplitsCreate(id, pluginInstanceSplitRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSplitsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final PluginInstanceSplitRequest pluginInstanceSplitRequest = new PluginInstanceSplitRequest(); // PluginInstanceSplitRequest | 

try {
    final result = await api_instance.pluginsInstancesSplitsCreate(id, pluginInstanceSplitRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesSplitsCreate: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        PluginInstanceSplitRequest pluginInstanceSplitRequest = ; // PluginInstanceSplitRequest | 

        try {
            PluginInstanceSplit result = apiInstance.pluginsInstancesSplitsCreate(id, pluginInstanceSplitRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSplitsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
PluginInstanceSplitRequest *pluginInstanceSplitRequest = ; //  (optional)

[apiInstance pluginsInstancesSplitsCreateWith:id
    pluginInstanceSplitRequest:pluginInstanceSplitRequest
              completionHandler: ^(PluginInstanceSplit output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'pluginInstanceSplitRequest':  // {PluginInstanceSplitRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesSplitsCreate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesSplitsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var pluginInstanceSplitRequest = new PluginInstanceSplitRequest(); // PluginInstanceSplitRequest |  (optional) 

            try {
                PluginInstanceSplit result = apiInstance.pluginsInstancesSplitsCreate(id, pluginInstanceSplitRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesSplitsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$pluginInstanceSplitRequest = ; // PluginInstanceSplitRequest | 

try {
    $result = $api_instance->pluginsInstancesSplitsCreate($id, $pluginInstanceSplitRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesSplitsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $pluginInstanceSplitRequest = WWW::OPenAPIClient::Object::PluginInstanceSplitRequest->new(); # PluginInstanceSplitRequest | 

eval {
    my $result = $api_instance->pluginsInstancesSplitsCreate(id => $id, pluginInstanceSplitRequest => $pluginInstanceSplitRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesSplitsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
pluginInstanceSplitRequest =  # PluginInstanceSplitRequest |  (optional)

try:
    api_response = api_instance.plugins_instances_splits_create(id, pluginInstanceSplitRequest=pluginInstanceSplitRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesSplitsCreate: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let pluginInstanceSplitRequest = ; // PluginInstanceSplitRequest

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesSplitsCreate(id, pluginInstanceSplitRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pluginInstanceSplitRequest

Responses


pluginsInstancesSplitsList

A view for the collection of splits for a plugin instance.


/api/v1/plugins/instances/{id}/splits/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/{id}/splits/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceSplitList result = apiInstance.pluginsInstancesSplitsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSplitsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsInstancesSplitsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesSplitsList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginInstanceSplitList result = apiInstance.pluginsInstancesSplitsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSplitsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsInstancesSplitsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginInstanceSplitList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesSplitsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesSplitsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginInstanceSplitList result = apiInstance.pluginsInstancesSplitsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesSplitsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsInstancesSplitsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesSplitsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsInstancesSplitsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesSplitsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_instances_splits_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesSplitsList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesSplitsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsInstancesSplitsRetrieve

A view for a plugin instance split.


/api/v1/plugins/instances/splits/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/instances/splits/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginInstanceSplit result = apiInstance.pluginsInstancesSplitsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSplitsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsInstancesSplitsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesSplitsRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginInstanceSplit result = apiInstance.pluginsInstancesSplitsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesSplitsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsInstancesSplitsRetrieveWith:id
              completionHandler: ^(PluginInstanceSplit output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsInstancesSplitsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesSplitsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PluginInstanceSplit result = apiInstance.pluginsInstancesSplitsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesSplitsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsInstancesSplitsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesSplitsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsInstancesSplitsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesSplitsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_instances_splits_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesSplitsRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesSplitsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsInstancesUpdate

A plugin instance view.


/api/v1/plugins/instances/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/plugins/instances/{id}/" \
 -d '{
  "cpu_limit" : 0,
  "previous_id" : 1210617418,
  "number_of_workers" : -1517921766,
  "memory_limit" : 6,
  "title" : "title",
  "gpu_limit" : 413233370,
  "compute_resource_name" : "compute_resource_name",
  "status" : "created"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        PluginInstanceRequest pluginInstanceRequest = ; // PluginInstanceRequest | 

        try {
            PluginInstance result = apiInstance.pluginsInstancesUpdate(id, pluginInstanceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final PluginInstanceRequest pluginInstanceRequest = new PluginInstanceRequest(); // PluginInstanceRequest | 

try {
    final result = await api_instance.pluginsInstancesUpdate(id, pluginInstanceRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsInstancesUpdate: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        PluginInstanceRequest pluginInstanceRequest = ; // PluginInstanceRequest | 

        try {
            PluginInstance result = apiInstance.pluginsInstancesUpdate(id, pluginInstanceRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsInstancesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
PluginInstanceRequest *pluginInstanceRequest = ; //  (optional)

[apiInstance pluginsInstancesUpdateWith:id
    pluginInstanceRequest:pluginInstanceRequest
              completionHandler: ^(PluginInstance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'pluginInstanceRequest':  // {PluginInstanceRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsInstancesUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsInstancesUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var pluginInstanceRequest = new PluginInstanceRequest(); // PluginInstanceRequest |  (optional) 

            try {
                PluginInstance result = apiInstance.pluginsInstancesUpdate(id, pluginInstanceRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsInstancesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$pluginInstanceRequest = ; // PluginInstanceRequest | 

try {
    $result = $api_instance->pluginsInstancesUpdate($id, $pluginInstanceRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsInstancesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $pluginInstanceRequest = WWW::OPenAPIClient::Object::PluginInstanceRequest->new(); # PluginInstanceRequest | 

eval {
    my $result = $api_instance->pluginsInstancesUpdate(id => $id, pluginInstanceRequest => $pluginInstanceRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsInstancesUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
pluginInstanceRequest =  # PluginInstanceRequest |  (optional)

try:
    api_response = api_instance.plugins_instances_update(id, pluginInstanceRequest=pluginInstanceRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsInstancesUpdate: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let pluginInstanceRequest = ; // PluginInstanceRequest

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsInstancesUpdate(id, pluginInstanceRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
pluginInstanceRequest

Responses


pluginsIntegerParameterRetrieve

An integer parameter view.


/api/v1/plugins/integer-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/integer-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            IntParameter result = apiInstance.pluginsIntegerParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsIntegerParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsIntegerParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsIntegerParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            IntParameter result = apiInstance.pluginsIntegerParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsIntegerParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsIntegerParameterRetrieveWith:id
              completionHandler: ^(IntParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsIntegerParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsIntegerParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                IntParameter result = apiInstance.pluginsIntegerParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsIntegerParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsIntegerParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsIntegerParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsIntegerParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsIntegerParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_integer_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsIntegerParameterRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsIntegerParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsList

A view for the collection of plugins.


/api/v1/plugins/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginList result = apiInstance.pluginsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginList result = apiInstance.pluginsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPluginList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginList result = apiInstance.pluginsList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsMetasList

A view for the collection of plugin metas.


/api/v1/plugins/metas/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/metas/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginMetaList result = apiInstance.pluginsMetasList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsMetasList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsMetasList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginMetaList result = apiInstance.pluginsMetasList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsMetasListWith:limit
    offset:offset
              completionHandler: ^(PaginatedPluginMetaList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsMetasList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsMetasListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginMetaList result = apiInstance.pluginsMetasList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsMetasList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsMetasList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsMetasList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsMetasList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsMetasList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_metas_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsMetasList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsMetasList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsMetasPluginsList

A view for the collection of meta-specific plugins.


/api/v1/plugins/metas/{id}/plugins/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/metas/{id}/plugins/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginList result = apiInstance.pluginsMetasPluginsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasPluginsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsMetasPluginsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsMetasPluginsList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginList result = apiInstance.pluginsMetasPluginsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasPluginsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsMetasPluginsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsMetasPluginsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsMetasPluginsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginList result = apiInstance.pluginsMetasPluginsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsMetasPluginsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsMetasPluginsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsMetasPluginsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsMetasPluginsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsMetasPluginsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_metas_plugins_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsMetasPluginsList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsMetasPluginsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsMetasRetrieve

A plugin meta view.


/api/v1/plugins/metas/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/metas/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginMeta result = apiInstance.pluginsMetasRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsMetasRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsMetasRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginMeta result = apiInstance.pluginsMetasRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsMetasRetrieveWith:id
              completionHandler: ^(PluginMeta output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsMetasRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsMetasRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PluginMeta result = apiInstance.pluginsMetasRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsMetasRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsMetasRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsMetasRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsMetasRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsMetasRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_metas_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsMetasRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsMetasRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsMetasSearchList

A view for the collection of plugin metas resulting from a query search.


/api/v1/plugins/metas/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/metas/search/?authors=authors_example&category=category_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&name=name_example&name_authors_category=nameAuthorsCategory_example&name_exact=nameExact_example&name_title_category=nameTitleCategory_example&offset=56&title=title_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        String authors = authors_example; // String | 
        String category = category_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        String name = name_example; // String | 
        String nameAuthorsCategory = nameAuthorsCategory_example; // String | 
        String nameExact = nameExact_example; // String | 
        String nameTitleCategory = nameTitleCategory_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String title = title_example; // String | 
        String type = type_example; // String | 

        try {
            PaginatedPluginMetaList result = apiInstance.pluginsMetasSearchList(authors, category, id, limit, maxCreationDate, minCreationDate, name, nameAuthorsCategory, nameExact, nameTitleCategory, offset, title, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String authors = new String(); // String | 
final String category = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final String name = new String(); // String | 
final String nameAuthorsCategory = new String(); // String | 
final String nameExact = new String(); // String | 
final String nameTitleCategory = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String title = new String(); // String | 
final String type = new String(); // String | 

try {
    final result = await api_instance.pluginsMetasSearchList(authors, category, id, limit, maxCreationDate, minCreationDate, name, nameAuthorsCategory, nameExact, nameTitleCategory, offset, title, type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsMetasSearchList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        String authors = authors_example; // String | 
        String category = category_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        String name = name_example; // String | 
        String nameAuthorsCategory = nameAuthorsCategory_example; // String | 
        String nameExact = nameExact_example; // String | 
        String nameTitleCategory = nameTitleCategory_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String title = title_example; // String | 
        String type = type_example; // String | 

        try {
            PaginatedPluginMetaList result = apiInstance.pluginsMetasSearchList(authors, category, id, limit, maxCreationDate, minCreationDate, name, nameAuthorsCategory, nameExact, nameTitleCategory, offset, title, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsMetasSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
String *authors = authors_example; //  (optional) (default to null)
String *category = category_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
String *nameAuthorsCategory = nameAuthorsCategory_example; //  (optional) (default to null)
String *nameExact = nameExact_example; //  (optional) (default to null)
String *nameTitleCategory = nameTitleCategory_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *title = title_example; //  (optional) (default to null)
String *type = type_example; //  (optional) (default to null)

[apiInstance pluginsMetasSearchListWith:authors
    category:category
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    name:name
    nameAuthorsCategory:nameAuthorsCategory
    nameExact:nameExact
    nameTitleCategory:nameTitleCategory
    offset:offset
    title:title
    type:type
              completionHandler: ^(PaginatedPluginMetaList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var opts = {
  'authors': authors_example, // {String} 
  'category': category_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'name': name_example, // {String} 
  'nameAuthorsCategory': nameAuthorsCategory_example, // {String} 
  'nameExact': nameExact_example, // {String} 
  'nameTitleCategory': nameTitleCategory_example, // {String} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'title': title_example, // {String} 
  '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.pluginsMetasSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsMetasSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var authors = authors_example;  // String |  (optional)  (default to null)
            var category = category_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var nameAuthorsCategory = nameAuthorsCategory_example;  // String |  (optional)  (default to null)
            var nameExact = nameExact_example;  // String |  (optional)  (default to null)
            var nameTitleCategory = nameTitleCategory_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var title = title_example;  // String |  (optional)  (default to null)
            var type = type_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPluginMetaList result = apiInstance.pluginsMetasSearchList(authors, category, id, limit, maxCreationDate, minCreationDate, name, nameAuthorsCategory, nameExact, nameTitleCategory, offset, title, type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsMetasSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$authors = authors_example; // String | 
$category = category_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$name = name_example; // String | 
$nameAuthorsCategory = nameAuthorsCategory_example; // String | 
$nameExact = nameExact_example; // String | 
$nameTitleCategory = nameTitleCategory_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.
$title = title_example; // String | 
$type = type_example; // String | 

try {
    $result = $api_instance->pluginsMetasSearchList($authors, $category, $id, $limit, $maxCreationDate, $minCreationDate, $name, $nameAuthorsCategory, $nameExact, $nameTitleCategory, $offset, $title, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsMetasSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $authors = authors_example; # String | 
my $category = category_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $name = name_example; # String | 
my $nameAuthorsCategory = nameAuthorsCategory_example; # String | 
my $nameExact = nameExact_example; # String | 
my $nameTitleCategory = nameTitleCategory_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $title = title_example; # String | 
my $type = type_example; # String | 

eval {
    my $result = $api_instance->pluginsMetasSearchList(authors => $authors, category => $category, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, name => $name, nameAuthorsCategory => $nameAuthorsCategory, nameExact => $nameExact, nameTitleCategory => $nameTitleCategory, offset => $offset, title => $title, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsMetasSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
authors = authors_example # String |  (optional) (default to null)
category = category_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
name = name_example # String |  (optional) (default to null)
nameAuthorsCategory = nameAuthorsCategory_example # String |  (optional) (default to null)
nameExact = nameExact_example # String |  (optional) (default to null)
nameTitleCategory = nameTitleCategory_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
title = title_example # String |  (optional) (default to null)
type = type_example # String |  (optional) (default to null)

try:
    api_response = api_instance.plugins_metas_search_list(authors=authors, category=category, id=id, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, name=name, nameAuthorsCategory=nameAuthorsCategory, nameExact=nameExact, nameTitleCategory=nameTitleCategory, offset=offset, title=title, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsMetasSearchList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let authors = authors_example; // String
    let category = category_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let name = name_example; // String
    let nameAuthorsCategory = nameAuthorsCategory_example; // String
    let nameExact = nameExact_example; // String
    let nameTitleCategory = nameTitleCategory_example; // String
    let offset = 56; // Integer
    let title = title_example; // String
    let type = type_example; // String

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsMetasSearchList(authors, category, id, limit, maxCreationDate, minCreationDate, name, nameAuthorsCategory, nameExact, nameTitleCategory, offset, title, type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
authors
String
category
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
name
String
name_authors_category
String
name_exact
String
name_title_category
String
offset
Integer
The initial index from which to return the results.
title
String
type
String

Responses


pluginsParametersList

A view for the collection of plugin parameters.


/api/v1/plugins/{id}/parameters/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/{id}/parameters/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginParameterList result = apiInstance.pluginsParametersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsParametersList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.pluginsParametersList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsParametersList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedPluginParameterList result = apiInstance.pluginsParametersList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsParametersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance pluginsParametersListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedPluginParameterList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsParametersList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsParametersListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedPluginParameterList result = apiInstance.pluginsParametersList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsParametersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->pluginsParametersList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsParametersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->pluginsParametersList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsParametersList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.plugins_parameters_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsParametersList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsParametersList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


pluginsParametersRetrieve

A plugin parameter view.


/api/v1/plugins/parameters/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/parameters/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginParameter result = apiInstance.pluginsParametersRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsParametersRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsParametersRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsParametersRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PluginParameter result = apiInstance.pluginsParametersRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsParametersRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsParametersRetrieveWith:id
              completionHandler: ^(PluginParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsParametersRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsParametersRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PluginParameter result = apiInstance.pluginsParametersRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsParametersRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsParametersRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsParametersRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsParametersRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsParametersRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_parameters_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsParametersRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsParametersRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsPathParameterRetrieve

A path parameter view.


/api/v1/plugins/path-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/path-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PathParameter result = apiInstance.pluginsPathParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsPathParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsPathParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsPathParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            PathParameter result = apiInstance.pluginsPathParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsPathParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsPathParameterRetrieveWith:id
              completionHandler: ^(PathParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsPathParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsPathParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                PathParameter result = apiInstance.pluginsPathParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsPathParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsPathParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsPathParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsPathParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsPathParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_path_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsPathParameterRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsPathParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsRetrieve

A plugin view.


/api/v1/plugins/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            Plugin result = apiInstance.pluginsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            Plugin result = apiInstance.pluginsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsRetrieveWith:id
              completionHandler: ^(Plugin output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Plugin result = apiInstance.pluginsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsSearchList

A view for the collection of plugins resulting from a query search.


/api/v1/plugins/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/search/?category=category_example&compute_resource_id=computeResourceId_example&description=description_example&dock_image=dockImage_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&name=name_example&name_exact=nameExact_example&name_title_category=nameTitleCategory_example&offset=56&title=title_example&type=type_example&version=version_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        String category = category_example; // String | 
        String computeResourceId = computeResourceId_example; // String | 
        String description = description_example; // String | 
        String dockImage = dockImage_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        String name = name_example; // String | 
        String nameExact = nameExact_example; // String | 
        String nameTitleCategory = nameTitleCategory_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String title = title_example; // String | 
        String type = type_example; // String | 
        String version = version_example; // String | 

        try {
            PaginatedPluginList result = apiInstance.pluginsSearchList(category, computeResourceId, description, dockImage, id, limit, maxCreationDate, minCreationDate, name, nameExact, nameTitleCategory, offset, title, type, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String category = new String(); // String | 
final String computeResourceId = new String(); // String | 
final String description = new String(); // String | 
final String dockImage = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final String name = new String(); // String | 
final String nameExact = new String(); // String | 
final String nameTitleCategory = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String title = new String(); // String | 
final String type = new String(); // String | 
final String version = new String(); // String | 

try {
    final result = await api_instance.pluginsSearchList(category, computeResourceId, description, dockImage, id, limit, maxCreationDate, minCreationDate, name, nameExact, nameTitleCategory, offset, title, type, version);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsSearchList: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        String category = category_example; // String | 
        String computeResourceId = computeResourceId_example; // String | 
        String description = description_example; // String | 
        String dockImage = dockImage_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        String name = name_example; // String | 
        String nameExact = nameExact_example; // String | 
        String nameTitleCategory = nameTitleCategory_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String title = title_example; // String | 
        String type = type_example; // String | 
        String version = version_example; // String | 

        try {
            PaginatedPluginList result = apiInstance.pluginsSearchList(category, computeResourceId, description, dockImage, id, limit, maxCreationDate, minCreationDate, name, nameExact, nameTitleCategory, offset, title, type, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
String *category = category_example; //  (optional) (default to null)
String *computeResourceId = computeResourceId_example; //  (optional) (default to null)
String *description = description_example; //  (optional) (default to null)
String *dockImage = dockImage_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
String *nameExact = nameExact_example; //  (optional) (default to null)
String *nameTitleCategory = nameTitleCategory_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *title = title_example; //  (optional) (default to null)
String *type = type_example; //  (optional) (default to null)
String *version = version_example; //  (optional) (default to null)

[apiInstance pluginsSearchListWith:category
    computeResourceId:computeResourceId
    description:description
    dockImage:dockImage
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    name:name
    nameExact:nameExact
    nameTitleCategory:nameTitleCategory
    offset:offset
    title:title
    type:type
    version:version
              completionHandler: ^(PaginatedPluginList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
var opts = {
  'category': category_example, // {String} 
  'computeResourceId': computeResourceId_example, // {String} 
  'description': description_example, // {String} 
  'dockImage': dockImage_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'name': name_example, // {String} 
  'nameExact': nameExact_example, // {String} 
  'nameTitleCategory': nameTitleCategory_example, // {String} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'title': title_example, // {String} 
  'type': type_example, // {String} 
  'version': version_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginsSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var category = category_example;  // String |  (optional)  (default to null)
            var computeResourceId = computeResourceId_example;  // String |  (optional)  (default to null)
            var description = description_example;  // String |  (optional)  (default to null)
            var dockImage = dockImage_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var nameExact = nameExact_example;  // String |  (optional)  (default to null)
            var nameTitleCategory = nameTitleCategory_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var title = title_example;  // String |  (optional)  (default to null)
            var type = type_example;  // String |  (optional)  (default to null)
            var version = version_example;  // String |  (optional)  (default to null)

            try {
                PaginatedPluginList result = apiInstance.pluginsSearchList(category, computeResourceId, description, dockImage, id, limit, maxCreationDate, minCreationDate, name, nameExact, nameTitleCategory, offset, title, type, version);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$category = category_example; // String | 
$computeResourceId = computeResourceId_example; // String | 
$description = description_example; // String | 
$dockImage = dockImage_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$name = name_example; // String | 
$nameExact = nameExact_example; // String | 
$nameTitleCategory = nameTitleCategory_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.
$title = title_example; // String | 
$type = type_example; // String | 
$version = version_example; // String | 

try {
    $result = $api_instance->pluginsSearchList($category, $computeResourceId, $description, $dockImage, $id, $limit, $maxCreationDate, $minCreationDate, $name, $nameExact, $nameTitleCategory, $offset, $title, $type, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $category = category_example; # String | 
my $computeResourceId = computeResourceId_example; # String | 
my $description = description_example; # String | 
my $dockImage = dockImage_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $name = name_example; # String | 
my $nameExact = nameExact_example; # String | 
my $nameTitleCategory = nameTitleCategory_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $title = title_example; # String | 
my $type = type_example; # String | 
my $version = version_example; # String | 

eval {
    my $result = $api_instance->pluginsSearchList(category => $category, computeResourceId => $computeResourceId, description => $description, dockImage => $dockImage, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, name => $name, nameExact => $nameExact, nameTitleCategory => $nameTitleCategory, offset => $offset, title => $title, type => $type, version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
category = category_example # String |  (optional) (default to null)
computeResourceId = computeResourceId_example # String |  (optional) (default to null)
description = description_example # String |  (optional) (default to null)
dockImage = dockImage_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
name = name_example # String |  (optional) (default to null)
nameExact = nameExact_example # String |  (optional) (default to null)
nameTitleCategory = nameTitleCategory_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
title = title_example # String |  (optional) (default to null)
type = type_example # String |  (optional) (default to null)
version = version_example # String |  (optional) (default to null)

try:
    api_response = api_instance.plugins_search_list(category=category, computeResourceId=computeResourceId, description=description, dockImage=dockImage, id=id, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, name=name, nameExact=nameExact, nameTitleCategory=nameTitleCategory, offset=offset, title=title, type=type, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsSearchList: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let category = category_example; // String
    let computeResourceId = computeResourceId_example; // String
    let description = description_example; // String
    let dockImage = dockImage_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let name = name_example; // String
    let nameExact = nameExact_example; // String
    let nameTitleCategory = nameTitleCategory_example; // String
    let offset = 56; // Integer
    let title = title_example; // String
    let type = type_example; // String
    let version = version_example; // String

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsSearchList(category, computeResourceId, description, dockImage, id, limit, maxCreationDate, minCreationDate, name, nameExact, nameTitleCategory, offset, title, type, version, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
category
String
compute_resource_id
String
description
String
dock_image
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
name
String
name_exact
String
name_title_category
String
offset
Integer
The initial index from which to return the results.
title
String
type
String
version
String

Responses


pluginsStringParameterRetrieve

A string parameter view.


/api/v1/plugins/string-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/string-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            StrParameter result = apiInstance.pluginsStringParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsStringParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsStringParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsStringParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            StrParameter result = apiInstance.pluginsStringParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsStringParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsStringParameterRetrieveWith:id
              completionHandler: ^(StrParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsStringParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsStringParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                StrParameter result = apiInstance.pluginsStringParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsStringParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsStringParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsStringParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsStringParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsStringParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_string_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsStringParameterRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsStringParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


pluginsUnextpathParameterRetrieve

A unextpath parameter view.


/api/v1/plugins/unextpath-parameter/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/plugins/unextpath-parameter/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PluginsApi;

import java.io.File;
import java.util.*;

public class PluginsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            UnextpathParameter result = apiInstance.pluginsUnextpathParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsUnextpathParameterRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.pluginsUnextpathParameterRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pluginsUnextpathParameterRetrieve: $e\n');
}

import org.openapitools.client.api.PluginsApi;

public class PluginsApiExample {
    public static void main(String[] args) {
        PluginsApi apiInstance = new PluginsApi();
        Integer id = 56; // Integer | 

        try {
            UnextpathParameter result = apiInstance.pluginsUnextpathParameterRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PluginsApi#pluginsUnextpathParameterRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PluginsApi *apiInstance = [[PluginsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance pluginsUnextpathParameterRetrieveWith:id
              completionHandler: ^(UnextpathParameter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PluginsApi()
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.pluginsUnextpathParameterRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class pluginsUnextpathParameterRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PluginsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                UnextpathParameter result = apiInstance.pluginsUnextpathParameterRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PluginsApi.pluginsUnextpathParameterRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PluginsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->pluginsUnextpathParameterRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PluginsApi->pluginsUnextpathParameterRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PluginsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PluginsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->pluginsUnextpathParameterRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PluginsApi->pluginsUnextpathParameterRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PluginsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.plugins_unextpath_parameter_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PluginsApi->pluginsUnextpathParameterRetrieve: %s\n" % e)
extern crate PluginsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = PluginsApi::Context::default();
    let result = client.pluginsUnextpathParameterRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


Publicfeeds

publicfeedsList

A view for the collection of public feeds.


/api/v1/publicfeeds/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/publicfeeds/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PublicfeedsApi;

import java.io.File;
import java.util.*;

public class PublicfeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PublicfeedsApi apiInstance = new PublicfeedsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.publicfeedsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicfeedsApi#publicfeedsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.publicfeedsList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->publicfeedsList: $e\n');
}

import org.openapitools.client.api.PublicfeedsApi;

public class PublicfeedsApiExample {
    public static void main(String[] args) {
        PublicfeedsApi apiInstance = new PublicfeedsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.publicfeedsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicfeedsApi#publicfeedsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PublicfeedsApi *apiInstance = [[PublicfeedsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance publicfeedsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedFeedList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PublicfeedsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicfeedsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class publicfeedsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PublicfeedsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedList result = apiInstance.publicfeedsList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PublicfeedsApi.publicfeedsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PublicfeedsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->publicfeedsList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicfeedsApi->publicfeedsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PublicfeedsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PublicfeedsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->publicfeedsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicfeedsApi->publicfeedsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PublicfeedsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.publicfeeds_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicfeedsApi->publicfeedsList: %s\n" % e)
extern crate PublicfeedsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = PublicfeedsApi::Context::default();
    let result = client.publicfeedsList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


publicfeedsSearchList

A view for the collection of public feeds resulting from a query search.


/api/v1/publicfeeds/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/publicfeeds/search/?files_fname_icontains=filesFnameIcontains_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&max_id=56&min_creation_date=2013-10-20T19:20:30+01:00&min_id=56&name=name_example&name_exact=nameExact_example&name_startswith=nameStartswith_example&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PublicfeedsApi;

import java.io.File;
import java.util.*;

public class PublicfeedsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PublicfeedsApi apiInstance = new PublicfeedsApi();
        String filesFnameIcontains = filesFnameIcontains_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer maxId = 56; // Integer | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer minId = 56; // Integer | 
        String name = name_example; // String | 
        String nameExact = nameExact_example; // String | 
        String nameStartswith = nameStartswith_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.publicfeedsSearchList(filesFnameIcontains, id, limit, maxCreationDate, maxId, minCreationDate, minId, name, nameExact, nameStartswith, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicfeedsApi#publicfeedsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String filesFnameIcontains = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Integer maxId = new Integer(); // Integer | 
final Date minCreationDate = new Date(); // Date | 
final Integer minId = new Integer(); // Integer | 
final String name = new String(); // String | 
final String nameExact = new String(); // String | 
final String nameStartswith = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.publicfeedsSearchList(filesFnameIcontains, id, limit, maxCreationDate, maxId, minCreationDate, minId, name, nameExact, nameStartswith, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->publicfeedsSearchList: $e\n');
}

import org.openapitools.client.api.PublicfeedsApi;

public class PublicfeedsApiExample {
    public static void main(String[] args) {
        PublicfeedsApi apiInstance = new PublicfeedsApi();
        String filesFnameIcontains = filesFnameIcontains_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer maxId = 56; // Integer | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer minId = 56; // Integer | 
        String name = name_example; // String | 
        String nameExact = nameExact_example; // String | 
        String nameStartswith = nameStartswith_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.publicfeedsSearchList(filesFnameIcontains, id, limit, maxCreationDate, maxId, minCreationDate, minId, name, nameExact, nameStartswith, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicfeedsApi#publicfeedsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
PublicfeedsApi *apiInstance = [[PublicfeedsApi alloc] init];
String *filesFnameIcontains = filesFnameIcontains_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *maxId = 56; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *minId = 56; //  (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
String *nameExact = nameExact_example; //  (optional) (default to null)
String *nameStartswith = nameStartswith_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance publicfeedsSearchListWith:filesFnameIcontains
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    maxId:maxId
    minCreationDate:minCreationDate
    minId:minId
    name:name
    nameExact:nameExact
    nameStartswith:nameStartswith
    offset:offset
              completionHandler: ^(PaginatedFeedList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.PublicfeedsApi()
var opts = {
  'filesFnameIcontains': filesFnameIcontains_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'maxId': 56, // {Integer} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minId': 56, // {Integer} 
  'name': name_example, // {String} 
  'nameExact': nameExact_example, // {String} 
  'nameStartswith': nameStartswith_example, // {String} 
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicfeedsSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class publicfeedsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PublicfeedsApi();
            var filesFnameIcontains = filesFnameIcontains_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var maxId = 56;  // Integer |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minId = 56;  // Integer |  (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var nameExact = nameExact_example;  // String |  (optional)  (default to null)
            var nameStartswith = nameStartswith_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedList result = apiInstance.publicfeedsSearchList(filesFnameIcontains, id, limit, maxCreationDate, maxId, minCreationDate, minId, name, nameExact, nameStartswith, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PublicfeedsApi.publicfeedsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PublicfeedsApi();
$filesFnameIcontains = filesFnameIcontains_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$maxId = 56; // Integer | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minId = 56; // Integer | 
$name = name_example; // String | 
$nameExact = nameExact_example; // String | 
$nameStartswith = nameStartswith_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->publicfeedsSearchList($filesFnameIcontains, $id, $limit, $maxCreationDate, $maxId, $minCreationDate, $minId, $name, $nameExact, $nameStartswith, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicfeedsApi->publicfeedsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PublicfeedsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PublicfeedsApi->new();
my $filesFnameIcontains = filesFnameIcontains_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $maxId = 56; # Integer | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minId = 56; # Integer | 
my $name = name_example; # String | 
my $nameExact = nameExact_example; # String | 
my $nameStartswith = nameStartswith_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->publicfeedsSearchList(filesFnameIcontains => $filesFnameIcontains, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, maxId => $maxId, minCreationDate => $minCreationDate, minId => $minId, name => $name, nameExact => $nameExact, nameStartswith => $nameStartswith, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicfeedsApi->publicfeedsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.PublicfeedsApi()
filesFnameIcontains = filesFnameIcontains_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
maxId = 56 # Integer |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minId = 56 # Integer |  (optional) (default to null)
name = name_example # String |  (optional) (default to null)
nameExact = nameExact_example # String |  (optional) (default to null)
nameStartswith = nameStartswith_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.publicfeeds_search_list(filesFnameIcontains=filesFnameIcontains, id=id, limit=limit, maxCreationDate=maxCreationDate, maxId=maxId, minCreationDate=minCreationDate, minId=minId, name=name, nameExact=nameExact, nameStartswith=nameStartswith, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicfeedsApi->publicfeedsSearchList: %s\n" % e)
extern crate PublicfeedsApi;

pub fn main() {
    let filesFnameIcontains = filesFnameIcontains_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let maxId = 56; // Integer
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minId = 56; // Integer
    let name = name_example; // String
    let nameExact = nameExact_example; // String
    let nameStartswith = nameStartswith_example; // String
    let offset = 56; // Integer

    let mut context = PublicfeedsApi::Context::default();
    let result = client.publicfeedsSearchList(filesFnameIcontains, id, limit, maxCreationDate, maxId, minCreationDate, minId, name, nameExact, nameStartswith, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
files_fname_icontains
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
max_id
Integer
min_creation_date
Date (date-time)
min_id
Integer
name
String
name_exact
String
name_startswith
String
offset
Integer
The initial index from which to return the results.

Responses


Schema

schemaRetrieve

OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json


/schema/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/vnd.oai.openapi,application/yaml,application/vnd.oai.openapi+json,application/json" \
 "http://localhost/schema/?format=format_example&lang=lang_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SchemaApi;

import java.io.File;
import java.util.*;

public class SchemaApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SchemaApi apiInstance = new SchemaApi();
        String format = format_example; // String | 
        String lang = lang_example; // String | 

        try {
            map['String', oas_any_type_not_mapped] result = apiInstance.schemaRetrieve(format, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#schemaRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String format = new String(); // String | 
final String lang = new String(); // String | 

try {
    final result = await api_instance.schemaRetrieve(format, lang);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->schemaRetrieve: $e\n');
}

import org.openapitools.client.api.SchemaApi;

public class SchemaApiExample {
    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        String format = format_example; // String | 
        String lang = lang_example; // String | 

        try {
            map['String', oas_any_type_not_mapped] result = apiInstance.schemaRetrieve(format, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#schemaRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
SchemaApi *apiInstance = [[SchemaApi alloc] init];
String *format = format_example; //  (optional) (default to null)
String *lang = lang_example; //  (optional) (default to null)

[apiInstance schemaRetrieveWith:format
    lang:lang
              completionHandler: ^(map['String', oas_any_type_not_mapped] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.SchemaApi()
var opts = {
  'format': format_example, // {String} 
  'lang': lang_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schemaRetrieve(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class schemaRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SchemaApi();
            var format = format_example;  // String |  (optional)  (default to null)
            var lang = lang_example;  // String |  (optional)  (default to null)

            try {
                map['String', oas_any_type_not_mapped] result = apiInstance.schemaRetrieve(format, lang);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SchemaApi.schemaRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SchemaApi();
$format = format_example; // String | 
$lang = lang_example; // String | 

try {
    $result = $api_instance->schemaRetrieve($format, $lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaApi->schemaRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SchemaApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SchemaApi->new();
my $format = format_example; # String | 
my $lang = lang_example; # String | 

eval {
    my $result = $api_instance->schemaRetrieve(format => $format, lang => $lang);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaApi->schemaRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.SchemaApi()
format = format_example # String |  (optional) (default to null)
lang = lang_example # String |  (optional) (default to null)

try:
    api_response = api_instance.schema_retrieve(format=format, lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaApi->schemaRetrieve: %s\n" % e)
extern crate SchemaApi;

pub fn main() {
    let format = format_example; // String
    let lang = lang_example; // String

    let mut context = SchemaApi::Context::default();
    let result = client.schemaRetrieve(format, lang, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
format
String
lang
String

Responses


Taggings

taggingsCreate

A view for the feed-specific collection of taggings.


/api/v1/{id}/taggings/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/taggings/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TaggingsApi;

import java.io.File;
import java.util.*;

public class TaggingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 

        try {
            Tagging result = apiInstance.taggingsCreate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.taggingsCreate(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->taggingsCreate: $e\n');
}

import org.openapitools.client.api.TaggingsApi;

public class TaggingsApiExample {
    public static void main(String[] args) {
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 

        try {
            Tagging result = apiInstance.taggingsCreate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TaggingsApi *apiInstance = [[TaggingsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance taggingsCreateWith:id
              completionHandler: ^(Tagging output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TaggingsApi()
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.taggingsCreate(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class taggingsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TaggingsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Tagging result = apiInstance.taggingsCreate(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TaggingsApi.taggingsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TaggingsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->taggingsCreate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaggingsApi->taggingsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TaggingsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TaggingsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->taggingsCreate(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaggingsApi->taggingsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TaggingsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.taggings_create(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaggingsApi->taggingsCreate: %s\n" % e)
extern crate TaggingsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = TaggingsApi::Context::default();
    let result = client.taggingsCreate(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


taggingsDestroy

A tagging view.


/api/v1/taggings/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/taggings/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TaggingsApi;

import java.io.File;
import java.util.*;

public class TaggingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.taggingsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.taggingsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->taggingsDestroy: $e\n');
}

import org.openapitools.client.api.TaggingsApi;

public class TaggingsApiExample {
    public static void main(String[] args) {
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.taggingsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TaggingsApi *apiInstance = [[TaggingsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance taggingsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TaggingsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.taggingsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class taggingsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TaggingsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.taggingsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling TaggingsApi.taggingsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TaggingsApi();
$id = 56; // Integer | 

try {
    $api_instance->taggingsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling TaggingsApi->taggingsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TaggingsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TaggingsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->taggingsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling TaggingsApi->taggingsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TaggingsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.taggings_destroy(id)
except ApiException as e:
    print("Exception when calling TaggingsApi->taggingsDestroy: %s\n" % e)
extern crate TaggingsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = TaggingsApi::Context::default();
    let result = client.taggingsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


taggingsList

A view for the feed-specific collection of taggings.


/api/v1/{id}/taggings/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/taggings/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TaggingsApi;

import java.io.File;
import java.util.*;

public class TaggingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTaggingList result = apiInstance.taggingsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.taggingsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->taggingsList: $e\n');
}

import org.openapitools.client.api.TaggingsApi;

public class TaggingsApiExample {
    public static void main(String[] args) {
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTaggingList result = apiInstance.taggingsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TaggingsApi *apiInstance = [[TaggingsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance taggingsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedTaggingList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TaggingsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.taggingsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class taggingsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TaggingsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedTaggingList result = apiInstance.taggingsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TaggingsApi.taggingsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TaggingsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->taggingsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaggingsApi->taggingsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TaggingsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TaggingsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->taggingsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaggingsApi->taggingsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TaggingsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.taggings_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaggingsApi->taggingsList: %s\n" % e)
extern crate TaggingsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = TaggingsApi::Context::default();
    let result = client.taggingsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


taggingsRetrieve

A tagging view.


/api/v1/taggings/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/taggings/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TaggingsApi;

import java.io.File;
import java.util.*;

public class TaggingsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 

        try {
            Tagging result = apiInstance.taggingsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.taggingsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->taggingsRetrieve: $e\n');
}

import org.openapitools.client.api.TaggingsApi;

public class TaggingsApiExample {
    public static void main(String[] args) {
        TaggingsApi apiInstance = new TaggingsApi();
        Integer id = 56; // Integer | 

        try {
            Tagging result = apiInstance.taggingsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaggingsApi#taggingsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TaggingsApi *apiInstance = [[TaggingsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance taggingsRetrieveWith:id
              completionHandler: ^(Tagging output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TaggingsApi()
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.taggingsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class taggingsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TaggingsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Tagging result = apiInstance.taggingsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TaggingsApi.taggingsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TaggingsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->taggingsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaggingsApi->taggingsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TaggingsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TaggingsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->taggingsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaggingsApi->taggingsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TaggingsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.taggings_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaggingsApi->taggingsRetrieve: %s\n" % e)
extern crate TaggingsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = TaggingsApi::Context::default();
    let result = client.taggingsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


Tags

feedTagsList

A view for a feed-specific collection of user-specific tags.


/api/v1/{id}/tags/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/tags/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTagList result = apiInstance.feedTagsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#feedTagsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.feedTagsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->feedTagsList: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTagList result = apiInstance.feedTagsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#feedTagsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance feedTagsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedTagList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.feedTagsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class feedTagsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedTagList result = apiInstance.feedTagsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.feedTagsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->feedTagsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->feedTagsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->feedTagsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->feedTagsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.feed_tags_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->feedTagsList: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.feedTagsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


tagsCreate

A view for the collection of tags.


/api/v1/tags/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/tags/" \
 -d '{
  "color" : "color",
  "name" : "name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        TagRequest tagRequest = ; // TagRequest | 

        try {
            Tag result = apiInstance.tagsCreate(tagRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final TagRequest tagRequest = new TagRequest(); // TagRequest | 

try {
    final result = await api_instance.tagsCreate(tagRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsCreate: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        TagRequest tagRequest = ; // TagRequest | 

        try {
            Tag result = apiInstance.tagsCreate(tagRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
TagRequest *tagRequest = ; // 

[apiInstance tagsCreateWith:tagRequest
              completionHandler: ^(Tag output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var tagRequest = ; // {TagRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsCreate(tagRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var tagRequest = new TagRequest(); // TagRequest | 

            try {
                Tag result = apiInstance.tagsCreate(tagRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$tagRequest = ; // TagRequest | 

try {
    $result = $api_instance->tagsCreate($tagRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $tagRequest = WWW::OPenAPIClient::Object::TagRequest->new(); # TagRequest | 

eval {
    my $result = $api_instance->tagsCreate(tagRequest => $tagRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
tagRequest =  # TagRequest | 

try:
    api_response = api_instance.tags_create(tagRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsCreate: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let tagRequest = ; // TagRequest

    let mut context = TagsApi::Context::default();
    let result = client.tagsCreate(tagRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
tagRequest *

Responses


tagsDestroy

A tag view.


/api/v1/tags/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/tags/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.tagsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.tagsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsDestroy: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.tagsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance tagsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.tagsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.tagsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 

try {
    $api_instance->tagsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->tagsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.tags_destroy(id)
except ApiException as e:
    print("Exception when calling TagsApi->tagsDestroy: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.tagsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


tagsFeedsList

A view for the tag-specific collection of feeds.


/api/v1/tags/{id}/feeds/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/tags/{id}/feeds/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.tagsFeedsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsFeedsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.tagsFeedsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsFeedsList: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedList result = apiInstance.tagsFeedsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsFeedsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance tagsFeedsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFeedList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsFeedsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsFeedsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedList result = apiInstance.tagsFeedsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsFeedsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->tagsFeedsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsFeedsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->tagsFeedsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsFeedsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.tags_feeds_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsFeedsList: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.tagsFeedsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


tagsList

A view for the collection of tags.


/api/v1/tags/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/tags/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTagList result = apiInstance.tagsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.tagsList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsList: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTagList result = apiInstance.tagsList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance tagsListWith:limit
    offset:offset
              completionHandler: ^(PaginatedTagList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedTagList result = apiInstance.tagsList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->tagsList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->tagsList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.tags_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsList: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.tagsList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


tagsRetrieve

A tag view.


/api/v1/tags/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/tags/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 

        try {
            Tag result = apiInstance.tagsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.tagsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsRetrieve: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 

        try {
            Tag result = apiInstance.tagsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance tagsRetrieveWith:id
              completionHandler: ^(Tag output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
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.tagsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Tag result = apiInstance.tagsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->tagsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->tagsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.tags_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsRetrieve: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.tagsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


tagsSearchList

A view for the collection of tags resulting from a query search.


/api/v1/tags/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/tags/search/?color=color_example&id=56&limit=56&name=name_example&offset=56&owner_username=ownerUsername_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        String color = color_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        String name = name_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedTagList result = apiInstance.tagsSearchList(color, id, limit, name, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String color = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final String name = new String(); // String | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String ownerUsername = new String(); // String | 

try {
    final result = await api_instance.tagsSearchList(color, id, limit, name, offset, ownerUsername);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsSearchList: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String color = color_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        String name = name_example; // String | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedTagList result = apiInstance.tagsSearchList(color, id, limit, name, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
String *color = color_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *ownerUsername = ownerUsername_example; //  (optional) (default to null)

[apiInstance tagsSearchListWith:color
    id:id
    limit:limit
    name:name
    offset:offset
    ownerUsername:ownerUsername
              completionHandler: ^(PaginatedTagList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var opts = {
  'color': color_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'name': name_example, // {String} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'ownerUsername': ownerUsername_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var color = color_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var ownerUsername = ownerUsername_example;  // String |  (optional)  (default to null)

            try {
                PaginatedTagList result = apiInstance.tagsSearchList(color, id, limit, name, offset, ownerUsername);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$color = color_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$name = name_example; // String | 
$offset = 56; // Integer | The initial index from which to return the results.
$ownerUsername = ownerUsername_example; // String | 

try {
    $result = $api_instance->tagsSearchList($color, $id, $limit, $name, $offset, $ownerUsername);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $color = color_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $name = name_example; # String | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $ownerUsername = ownerUsername_example; # String | 

eval {
    my $result = $api_instance->tagsSearchList(color => $color, id => $id, limit => $limit, name => $name, offset => $offset, ownerUsername => $ownerUsername);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
color = color_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
name = name_example # String |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
ownerUsername = ownerUsername_example # String |  (optional) (default to null)

try:
    api_response = api_instance.tags_search_list(color=color, id=id, limit=limit, name=name, offset=offset, ownerUsername=ownerUsername)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsSearchList: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let color = color_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let name = name_example; // String
    let offset = 56; // Integer
    let ownerUsername = ownerUsername_example; // String

    let mut context = TagsApi::Context::default();
    let result = client.tagsSearchList(color, id, limit, name, offset, ownerUsername, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
color
String
id
Integer
limit
Integer
Number of results to return per page.
name
String
offset
Integer
The initial index from which to return the results.
owner_username
String

Responses


tagsTaggingsCreate

A view for the collection of tag-specific taggings.


/api/v1/tags/{id}/taggings/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/tags/{id}/taggings/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 

        try {
            Tagging result = apiInstance.tagsTaggingsCreate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsTaggingsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.tagsTaggingsCreate(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsTaggingsCreate: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 

        try {
            Tagging result = apiInstance.tagsTaggingsCreate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsTaggingsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance tagsTaggingsCreateWith:id
              completionHandler: ^(Tagging output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
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.tagsTaggingsCreate(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsTaggingsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                Tagging result = apiInstance.tagsTaggingsCreate(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsTaggingsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->tagsTaggingsCreate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsTaggingsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->tagsTaggingsCreate(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsTaggingsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.tags_taggings_create(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsTaggingsCreate: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.tagsTaggingsCreate(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


tagsTaggingsList

A view for the collection of tag-specific taggings.


/api/v1/tags/{id}/taggings/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/tags/{id}/taggings/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTaggingList result = apiInstance.tagsTaggingsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsTaggingsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.tagsTaggingsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsTaggingsList: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedTaggingList result = apiInstance.tagsTaggingsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsTaggingsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance tagsTaggingsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedTaggingList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsTaggingsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsTaggingsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedTaggingList result = apiInstance.tagsTaggingsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsTaggingsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->tagsTaggingsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsTaggingsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->tagsTaggingsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsTaggingsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.tags_taggings_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsTaggingsList: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = TagsApi::Context::default();
    let result = client.tagsTaggingsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


tagsUpdate

A tag view.


/api/v1/tags/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/tags/{id}/" \
 -d '{
  "color" : "color",
  "name" : "name"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TagsApi;

import java.io.File;
import java.util.*;

public class TagsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        TagRequest tagRequest = ; // TagRequest | 

        try {
            Tag result = apiInstance.tagsUpdate(id, tagRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final TagRequest tagRequest = new TagRequest(); // TagRequest | 

try {
    final result = await api_instance.tagsUpdate(id, tagRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->tagsUpdate: $e\n');
}

import org.openapitools.client.api.TagsApi;

public class TagsApiExample {
    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer id = 56; // Integer | 
        TagRequest tagRequest = ; // TagRequest | 

        try {
            Tag result = apiInstance.tagsUpdate(id, tagRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#tagsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
TagsApi *apiInstance = [[TagsApi alloc] init];
Integer *id = 56; //  (default to null)
TagRequest *tagRequest = ; // 

[apiInstance tagsUpdateWith:id
    tagRequest:tagRequest
              completionHandler: ^(Tag output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.TagsApi()
var id = 56; // {Integer} 
var tagRequest = ; // {TagRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tagsUpdate(id, tagRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class tagsUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TagsApi();
            var id = 56;  // Integer |  (default to null)
            var tagRequest = new TagRequest(); // TagRequest | 

            try {
                Tag result = apiInstance.tagsUpdate(id, tagRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TagsApi.tagsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TagsApi();
$id = 56; // Integer | 
$tagRequest = ; // TagRequest | 

try {
    $result = $api_instance->tagsUpdate($id, $tagRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->tagsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TagsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TagsApi->new();
my $id = 56; # Integer | 
my $tagRequest = WWW::OPenAPIClient::Object::TagRequest->new(); # TagRequest | 

eval {
    my $result = $api_instance->tagsUpdate(id => $id, tagRequest => $tagRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TagsApi->tagsUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.TagsApi()
id = 56 # Integer |  (default to null)
tagRequest =  # TagRequest | 

try:
    api_response = api_instance.tags_update(id, tagRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->tagsUpdate: %s\n" % e)
extern crate TagsApi;

pub fn main() {
    let id = 56; // Integer
    let tagRequest = ; // TagRequest

    let mut context = TagsApi::Context::default();
    let result = client.tagsUpdate(id, tagRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
tagRequest *

Responses


Userfiles

userfiles.Retrieve

Overriden to be able to make a GET request to an actual file resource.


/api/v1/userfiles/{id}/.

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
 \
-H "download_token: [[apiKey]]" \
 -H "Accept: */*" \
 "http://localhost/api/v1/userfiles/{id}/."
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: DownloadTokenInQueryString
        ApiKeyAuth DownloadTokenInQueryString = (ApiKeyAuth) defaultClient.getAuthentication("DownloadTokenInQueryString");
        DownloadTokenInQueryString.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //DownloadTokenInQueryString.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.userfiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfiles.Retrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 

try {
    final result = await api_instance.userfiles.Retrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfiles.Retrieve: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        String id = id_example; // String | 

        try {
            File result = apiInstance.userfiles.Retrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfiles.Retrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];

// Configure API key authorization: (authentication scheme: DownloadTokenInQueryString)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"download_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"download_token"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
String *id = id_example; //  (default to null)

[apiInstance userfiles.RetrieveWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Configure API key authorization: DownloadTokenInQueryString
var DownloadTokenInQueryString = defaultClient.authentications['DownloadTokenInQueryString'];
DownloadTokenInQueryString.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//DownloadTokenInQueryString.apiKeyPrefix['download_token'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
var id = id_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userfiles.Retrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfiles.RetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");
            // Configure API key authorization: DownloadTokenInQueryString
            Configuration.Default.ApiKey.Add("download_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("download_token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var id = id_example;  // String |  (default to null)

            try {
                File result = apiInstance.userfiles.Retrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfiles.Retrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Configure API key authorization: DownloadTokenInQueryString
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('download_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('download_token', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$id = id_example; // String | 

try {
    $result = $api_instance->userfiles.Retrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfiles.Retrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Configure API key authorization: DownloadTokenInQueryString
$WWW::OPenAPIClient::Configuration::api_key->{'download_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'download_token'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $id = id_example; # String | 

eval {
    my $result = $api_instance->userfiles.Retrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfiles.Retrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Configure API key authorization: DownloadTokenInQueryString
chris_oag.configuration.api_key['download_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['download_token'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
id = id_example # String |  (default to null)

try:
    api_response = api_instance.userfiles/retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfiles.Retrieve: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let id = id_example; // String

    let mut context = UserfilesApi::Context::default();
    let result = client.userfiles.Retrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required

Responses


userfilesCreate

A view for the collection of user files.


/api/v1/userfiles/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/userfiles/" \
 -d '{
  "fname" : "",
  "public" : true,
  "upload_path" : "upload_path"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        UserFileRequest userFileRequest = ; // UserFileRequest | 

        try {
            UserFile result = apiInstance.userfilesCreate(userFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserFileRequest userFileRequest = new UserFileRequest(); // UserFileRequest | 

try {
    final result = await api_instance.userfilesCreate(userFileRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfilesCreate: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        UserFileRequest userFileRequest = ; // UserFileRequest | 

        try {
            UserFile result = apiInstance.userfilesCreate(userFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
UserFileRequest *userFileRequest = ; //  (optional)

[apiInstance userfilesCreateWith:userFileRequest
              completionHandler: ^(UserFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
var opts = {
  'userFileRequest':  // {UserFileRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userfilesCreate(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfilesCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var userFileRequest = new UserFileRequest(); // UserFileRequest |  (optional) 

            try {
                UserFile result = apiInstance.userfilesCreate(userFileRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfilesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$userFileRequest = ; // UserFileRequest | 

try {
    $result = $api_instance->userfilesCreate($userFileRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfilesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $userFileRequest = WWW::OPenAPIClient::Object::UserFileRequest->new(); # UserFileRequest | 

eval {
    my $result = $api_instance->userfilesCreate(userFileRequest => $userFileRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfilesCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
userFileRequest =  # UserFileRequest |  (optional)

try:
    api_response = api_instance.userfiles_create(userFileRequest=userFileRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfilesCreate: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let userFileRequest = ; // UserFileRequest

    let mut context = UserfilesApi::Context::default();
    let result = client.userfilesCreate(userFileRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userFileRequest

Responses


userfilesDestroy

A user file view.


/api/v1/userfiles/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/userfiles/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.userfilesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.userfilesDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfilesDestroy: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.userfilesDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance userfilesDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userfilesDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfilesDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.userfilesDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfilesDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$id = 56; // Integer | 

try {
    $api_instance->userfilesDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfilesDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->userfilesDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfilesDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.userfiles_destroy(id)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfilesDestroy: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = UserfilesApi::Context::default();
    let result = client.userfilesDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


userfilesList

A view for the collection of user files.


/api/v1/userfiles/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/userfiles/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedUserFileList result = apiInstance.userfilesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.userfilesList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfilesList: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedUserFileList result = apiInstance.userfilesList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance userfilesListWith:limit
    offset:offset
              completionHandler: ^(PaginatedUserFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userfilesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfilesListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedUserFileList result = apiInstance.userfilesList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->userfilesList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->userfilesList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfilesList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.userfiles_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfilesList: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = UserfilesApi::Context::default();
    let result = client.userfilesList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


userfilesRetrieve

A user file view.


/api/v1/userfiles/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/userfiles/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        Integer id = 56; // Integer | 

        try {
            UserFile result = apiInstance.userfilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.userfilesRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfilesRetrieve: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        Integer id = 56; // Integer | 

        try {
            UserFile result = apiInstance.userfilesRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance userfilesRetrieveWith:id
              completionHandler: ^(UserFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
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.userfilesRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfilesRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var id = 56;  // Integer |  (default to null)

            try {
                UserFile result = apiInstance.userfilesRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfilesRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->userfilesRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfilesRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->userfilesRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfilesRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.userfiles_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfilesRetrieve: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = UserfilesApi::Context::default();
    let result = client.userfilesRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


userfilesSearchList

A view for the collection of user files resulting from a query search.


/api/v1/userfiles/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/userfiles/search/?fname=fname_example&fname_exact=fnameExact_example&fname_icontains=fnameIcontains_example&fname_icontains_multiple=fnameIcontainsMultiple_example&fname_nslashes=fnameNslashes_example&id=56&limit=56&max_creation_date=2013-10-20T19:20:30+01:00&min_creation_date=2013-10-20T19:20:30+01:00&offset=56&owner_username=ownerUsername_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        String fname = fname_example; // String | 
        String fnameExact = fnameExact_example; // String | 
        String fnameIcontains = fnameIcontains_example; // String | 
        String fnameIcontainsMultiple = fnameIcontainsMultiple_example; // String | 
        String fnameNslashes = fnameNslashes_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedUserFileList result = apiInstance.userfilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsMultiple, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String fname = new String(); // String | 
final String fnameExact = new String(); // String | 
final String fnameIcontains = new String(); // String | 
final String fnameIcontainsMultiple = new String(); // String | 
final String fnameNslashes = new String(); // String | 
final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Date maxCreationDate = new Date(); // Date | 
final Date minCreationDate = new Date(); // Date | 
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String ownerUsername = new String(); // String | 

try {
    final result = await api_instance.userfilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsMultiple, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfilesSearchList: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        String fname = fname_example; // String | 
        String fnameExact = fnameExact_example; // String | 
        String fnameIcontains = fnameIcontains_example; // String | 
        String fnameIcontainsMultiple = fnameIcontainsMultiple_example; // String | 
        String fnameNslashes = fnameNslashes_example; // String | 
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Date maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Date minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String ownerUsername = ownerUsername_example; // String | 

        try {
            PaginatedUserFileList result = apiInstance.userfilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsMultiple, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
String *fname = fname_example; //  (optional) (default to null)
String *fnameExact = fnameExact_example; //  (optional) (default to null)
String *fnameIcontains = fnameIcontains_example; //  (optional) (default to null)
String *fnameIcontainsMultiple = fnameIcontainsMultiple_example; //  (optional) (default to null)
String *fnameNslashes = fnameNslashes_example; //  (optional) (default to null)
Integer *id = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Date *maxCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Date *minCreationDate = 2013-10-20T19:20:30+01:00; //  (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *ownerUsername = ownerUsername_example; //  (optional) (default to null)

[apiInstance userfilesSearchListWith:fname
    fnameExact:fnameExact
    fnameIcontains:fnameIcontains
    fnameIcontainsMultiple:fnameIcontainsMultiple
    fnameNslashes:fnameNslashes
    id:id
    limit:limit
    maxCreationDate:maxCreationDate
    minCreationDate:minCreationDate
    offset:offset
    ownerUsername:ownerUsername
              completionHandler: ^(PaginatedUserFileList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
var opts = {
  'fname': fname_example, // {String} 
  'fnameExact': fnameExact_example, // {String} 
  'fnameIcontains': fnameIcontains_example, // {String} 
  'fnameIcontainsMultiple': fnameIcontainsMultiple_example, // {String} 
  'fnameNslashes': fnameNslashes_example, // {String} 
  'id': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'maxCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'minCreationDate': 2013-10-20T19:20:30+01:00, // {Date} 
  'offset': 56, // {Integer} The initial index from which to return the results.
  'ownerUsername': ownerUsername_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userfilesSearchList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfilesSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var fname = fname_example;  // String |  (optional)  (default to null)
            var fnameExact = fnameExact_example;  // String |  (optional)  (default to null)
            var fnameIcontains = fnameIcontains_example;  // String |  (optional)  (default to null)
            var fnameIcontainsMultiple = fnameIcontainsMultiple_example;  // String |  (optional)  (default to null)
            var fnameNslashes = fnameNslashes_example;  // String |  (optional)  (default to null)
            var id = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var maxCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var minCreationDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var ownerUsername = ownerUsername_example;  // String |  (optional)  (default to null)

            try {
                PaginatedUserFileList result = apiInstance.userfilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsMultiple, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset, ownerUsername);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfilesSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$fname = fname_example; // String | 
$fnameExact = fnameExact_example; // String | 
$fnameIcontains = fnameIcontains_example; // String | 
$fnameIcontainsMultiple = fnameIcontainsMultiple_example; // String | 
$fnameNslashes = fnameNslashes_example; // String | 
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$maxCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$minCreationDate = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | The initial index from which to return the results.
$ownerUsername = ownerUsername_example; // String | 

try {
    $result = $api_instance->userfilesSearchList($fname, $fnameExact, $fnameIcontains, $fnameIcontainsMultiple, $fnameNslashes, $id, $limit, $maxCreationDate, $minCreationDate, $offset, $ownerUsername);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfilesSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $fname = fname_example; # String | 
my $fnameExact = fnameExact_example; # String | 
my $fnameIcontains = fnameIcontains_example; # String | 
my $fnameIcontainsMultiple = fnameIcontainsMultiple_example; # String | 
my $fnameNslashes = fnameNslashes_example; # String | 
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $maxCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $minCreationDate = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | The initial index from which to return the results.
my $ownerUsername = ownerUsername_example; # String | 

eval {
    my $result = $api_instance->userfilesSearchList(fname => $fname, fnameExact => $fnameExact, fnameIcontains => $fnameIcontains, fnameIcontainsMultiple => $fnameIcontainsMultiple, fnameNslashes => $fnameNslashes, id => $id, limit => $limit, maxCreationDate => $maxCreationDate, minCreationDate => $minCreationDate, offset => $offset, ownerUsername => $ownerUsername);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfilesSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
fname = fname_example # String |  (optional) (default to null)
fnameExact = fnameExact_example # String |  (optional) (default to null)
fnameIcontains = fnameIcontains_example # String |  (optional) (default to null)
fnameIcontainsMultiple = fnameIcontainsMultiple_example # String |  (optional) (default to null)
fnameNslashes = fnameNslashes_example # String |  (optional) (default to null)
id = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
maxCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
minCreationDate = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
ownerUsername = ownerUsername_example # String |  (optional) (default to null)

try:
    api_response = api_instance.userfiles_search_list(fname=fname, fnameExact=fnameExact, fnameIcontains=fnameIcontains, fnameIcontainsMultiple=fnameIcontainsMultiple, fnameNslashes=fnameNslashes, id=id, limit=limit, maxCreationDate=maxCreationDate, minCreationDate=minCreationDate, offset=offset, ownerUsername=ownerUsername)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfilesSearchList: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let fname = fname_example; // String
    let fnameExact = fnameExact_example; // String
    let fnameIcontains = fnameIcontains_example; // String
    let fnameIcontainsMultiple = fnameIcontainsMultiple_example; // String
    let fnameNslashes = fnameNslashes_example; // String
    let id = 56; // Integer
    let limit = 56; // Integer
    let maxCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let minCreationDate = 2013-10-20T19:20:30+01:00; // Date
    let offset = 56; // Integer
    let ownerUsername = ownerUsername_example; // String

    let mut context = UserfilesApi::Context::default();
    let result = client.userfilesSearchList(fname, fnameExact, fnameIcontains, fnameIcontainsMultiple, fnameNslashes, id, limit, maxCreationDate, minCreationDate, offset, ownerUsername, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
fname
String
fname_exact
String
fname_icontains
String
fname_icontains_multiple
String
fname_nslashes
String
id
Integer
limit
Integer
Number of results to return per page.
max_creation_date
Date (date-time)
min_creation_date
Date (date-time)
offset
Integer
The initial index from which to return the results.
owner_username
String

Responses


userfilesUpdate

A user file view.


/api/v1/userfiles/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/userfiles/{id}/" \
 -d '{
  "fname" : "",
  "public" : true,
  "upload_path" : "upload_path"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserfilesApi;

import java.io.File;
import java.util.*;

public class UserfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserfilesApi apiInstance = new UserfilesApi();
        Integer id = 56; // Integer | 
        UserFileRequest userFileRequest = ; // UserFileRequest | 

        try {
            UserFile result = apiInstance.userfilesUpdate(id, userFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final UserFileRequest userFileRequest = new UserFileRequest(); // UserFileRequest | 

try {
    final result = await api_instance.userfilesUpdate(id, userFileRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userfilesUpdate: $e\n');
}

import org.openapitools.client.api.UserfilesApi;

public class UserfilesApiExample {
    public static void main(String[] args) {
        UserfilesApi apiInstance = new UserfilesApi();
        Integer id = 56; // Integer | 
        UserFileRequest userFileRequest = ; // UserFileRequest | 

        try {
            UserFile result = apiInstance.userfilesUpdate(id, userFileRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserfilesApi#userfilesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserfilesApi *apiInstance = [[UserfilesApi alloc] init];
Integer *id = 56; //  (default to null)
UserFileRequest *userFileRequest = ; //  (optional)

[apiInstance userfilesUpdateWith:id
    userFileRequest:userFileRequest
              completionHandler: ^(UserFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserfilesApi()
var id = 56; // {Integer} 
var opts = {
  'userFileRequest':  // {UserFileRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userfilesUpdate(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userfilesUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserfilesApi();
            var id = 56;  // Integer |  (default to null)
            var userFileRequest = new UserFileRequest(); // UserFileRequest |  (optional) 

            try {
                UserFile result = apiInstance.userfilesUpdate(id, userFileRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserfilesApi.userfilesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserfilesApi();
$id = 56; // Integer | 
$userFileRequest = ; // UserFileRequest | 

try {
    $result = $api_instance->userfilesUpdate($id, $userFileRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserfilesApi->userfilesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserfilesApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserfilesApi->new();
my $id = 56; # Integer | 
my $userFileRequest = WWW::OPenAPIClient::Object::UserFileRequest->new(); # UserFileRequest | 

eval {
    my $result = $api_instance->userfilesUpdate(id => $id, userFileRequest => $userFileRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserfilesApi->userfilesUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserfilesApi()
id = 56 # Integer |  (default to null)
userFileRequest =  # UserFileRequest |  (optional)

try:
    api_response = api_instance.userfiles_update(id, userFileRequest=userFileRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserfilesApi->userfilesUpdate: %s\n" % e)
extern crate UserfilesApi;

pub fn main() {
    let id = 56; // Integer
    let userFileRequest = ; // UserFileRequest

    let mut context = UserfilesApi::Context::default();
    let result = client.userfilesUpdate(id, userFileRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
userFileRequest

Responses


Userpermissions

userpermissionsCreate

A view for a feed's collection of user permissions.


/api/v1/{id}/userpermissions/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/{id}/userpermissions/" \
 -d '{
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserpermissionsApi;

import java.io.File;
import java.util.*;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 
        FeedUserPermissionRequest feedUserPermissionRequest = ; // FeedUserPermissionRequest | 

        try {
            FeedUserPermission result = apiInstance.userpermissionsCreate(id, feedUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final FeedUserPermissionRequest feedUserPermissionRequest = new FeedUserPermissionRequest(); // FeedUserPermissionRequest | 

try {
    final result = await api_instance.userpermissionsCreate(id, feedUserPermissionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userpermissionsCreate: $e\n');
}

import org.openapitools.client.api.UserpermissionsApi;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 
        FeedUserPermissionRequest feedUserPermissionRequest = ; // FeedUserPermissionRequest | 

        try {
            FeedUserPermission result = apiInstance.userpermissionsCreate(id, feedUserPermissionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserpermissionsApi *apiInstance = [[UserpermissionsApi alloc] init];
Integer *id = 56; //  (default to null)
FeedUserPermissionRequest *feedUserPermissionRequest = ; // 

[apiInstance userpermissionsCreateWith:id
    feedUserPermissionRequest:feedUserPermissionRequest
              completionHandler: ^(FeedUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserpermissionsApi()
var id = 56; // {Integer} 
var feedUserPermissionRequest = ; // {FeedUserPermissionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userpermissionsCreate(id, feedUserPermissionRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userpermissionsCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserpermissionsApi();
            var id = 56;  // Integer |  (default to null)
            var feedUserPermissionRequest = new FeedUserPermissionRequest(); // FeedUserPermissionRequest | 

            try {
                FeedUserPermission result = apiInstance.userpermissionsCreate(id, feedUserPermissionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserpermissionsApi.userpermissionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserpermissionsApi();
$id = 56; // Integer | 
$feedUserPermissionRequest = ; // FeedUserPermissionRequest | 

try {
    $result = $api_instance->userpermissionsCreate($id, $feedUserPermissionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserpermissionsApi->userpermissionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserpermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserpermissionsApi->new();
my $id = 56; # Integer | 
my $feedUserPermissionRequest = WWW::OPenAPIClient::Object::FeedUserPermissionRequest->new(); # FeedUserPermissionRequest | 

eval {
    my $result = $api_instance->userpermissionsCreate(id => $id, feedUserPermissionRequest => $feedUserPermissionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserpermissionsApi->userpermissionsCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserpermissionsApi()
id = 56 # Integer |  (default to null)
feedUserPermissionRequest =  # FeedUserPermissionRequest | 

try:
    api_response = api_instance.userpermissions_create(id, feedUserPermissionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserpermissionsApi->userpermissionsCreate: %s\n" % e)
extern crate UserpermissionsApi;

pub fn main() {
    let id = 56; // Integer
    let feedUserPermissionRequest = ; // FeedUserPermissionRequest

    let mut context = UserpermissionsApi::Context::default();
    let result = client.userpermissionsCreate(id, feedUserPermissionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
feedUserPermissionRequest *

Responses


userpermissionsDestroy

A view for a feed's user permission.


/api/v1/userpermissions/{id}/

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 "http://localhost/api/v1/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserpermissionsApi;

import java.io.File;
import java.util.*;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.userpermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsDestroy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.userpermissionsDestroy(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userpermissionsDestroy: $e\n');
}

import org.openapitools.client.api.UserpermissionsApi;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.userpermissionsDestroy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsDestroy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserpermissionsApi *apiInstance = [[UserpermissionsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance userpermissionsDestroyWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserpermissionsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.userpermissionsDestroy(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userpermissionsDestroyExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserpermissionsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.userpermissionsDestroy(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserpermissionsApi.userpermissionsDestroy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserpermissionsApi();
$id = 56; // Integer | 

try {
    $api_instance->userpermissionsDestroy($id);
} catch (Exception $e) {
    echo 'Exception when calling UserpermissionsApi->userpermissionsDestroy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserpermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserpermissionsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->userpermissionsDestroy(id => $id);
};
if ($@) {
    warn "Exception when calling UserpermissionsApi->userpermissionsDestroy: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserpermissionsApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.userpermissions_destroy(id)
except ApiException as e:
    print("Exception when calling UserpermissionsApi->userpermissionsDestroy: %s\n" % e)
extern crate UserpermissionsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = UserpermissionsApi::Context::default();
    let result = client.userpermissionsDestroy(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


userpermissionsList

A view for a feed's collection of user permissions.


/api/v1/{id}/userpermissions/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/userpermissions/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserpermissionsApi;

import java.io.File;
import java.util.*;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedUserPermissionList result = apiInstance.userpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.userpermissionsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userpermissionsList: $e\n');
}

import org.openapitools.client.api.UserpermissionsApi;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedFeedUserPermissionList result = apiInstance.userpermissionsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserpermissionsApi *apiInstance = [[UserpermissionsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance userpermissionsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedFeedUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserpermissionsApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userpermissionsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userpermissionsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserpermissionsApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedFeedUserPermissionList result = apiInstance.userpermissionsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserpermissionsApi.userpermissionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserpermissionsApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->userpermissionsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserpermissionsApi->userpermissionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserpermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserpermissionsApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->userpermissionsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserpermissionsApi->userpermissionsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserpermissionsApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.userpermissions_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserpermissionsApi->userpermissionsList: %s\n" % e)
extern crate UserpermissionsApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = UserpermissionsApi::Context::default();
    let result = client.userpermissionsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


userpermissionsRetrieve

A view for a feed's user permission.


/api/v1/userpermissions/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/userpermissions/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserpermissionsApi;

import java.io.File;
import java.util.*;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 

        try {
            FeedUserPermission result = apiInstance.userpermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.userpermissionsRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userpermissionsRetrieve: $e\n');
}

import org.openapitools.client.api.UserpermissionsApi;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 

        try {
            FeedUserPermission result = apiInstance.userpermissionsRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserpermissionsApi *apiInstance = [[UserpermissionsApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance userpermissionsRetrieveWith:id
              completionHandler: ^(FeedUserPermission output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserpermissionsApi()
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.userpermissionsRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userpermissionsRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserpermissionsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                FeedUserPermission result = apiInstance.userpermissionsRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserpermissionsApi.userpermissionsRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserpermissionsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->userpermissionsRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserpermissionsApi->userpermissionsRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserpermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserpermissionsApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->userpermissionsRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserpermissionsApi->userpermissionsRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserpermissionsApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.userpermissions_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserpermissionsApi->userpermissionsRetrieve: %s\n" % e)
extern crate UserpermissionsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = UserpermissionsApi::Context::default();
    let result = client.userpermissionsRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


userpermissionsSearchList

A view for the collection of feed-specific user permissions resulting from a query search.


/api/v1/{id}/userpermissions/search/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/{id}/userpermissions/search/?id=56&limit=56&offset=56&username=username_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserpermissionsApi;

import java.io.File;
import java.util.*;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFeedUserPermissionList result = apiInstance.userpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer id2 = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.
final String username = new String(); // String | 

try {
    final result = await api_instance.userpermissionsSearchList(id, id2, limit, offset, username);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->userpermissionsSearchList: $e\n');
}

import org.openapitools.client.api.UserpermissionsApi;

public class UserpermissionsApiExample {
    public static void main(String[] args) {
        UserpermissionsApi apiInstance = new UserpermissionsApi();
        Integer id = 56; // Integer | 
        Integer id2 = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.
        String username = username_example; // String | 

        try {
            PaginatedFeedUserPermissionList result = apiInstance.userpermissionsSearchList(id, id2, limit, offset, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserpermissionsApi#userpermissionsSearchList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UserpermissionsApi *apiInstance = [[UserpermissionsApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *id2 = 56; //  (optional) (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)
String *username = username_example; //  (optional) (default to null)

[apiInstance userpermissionsSearchListWith:id
    id2:id2
    limit:limit
    offset:offset
    username:username
              completionHandler: ^(PaginatedFeedUserPermissionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UserpermissionsApi()
var id = 56; // {Integer} 
var opts = {
  'id2': 56, // {Integer} 
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56, // {Integer} The initial index from which to return the results.
  'username': username_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userpermissionsSearchList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userpermissionsSearchListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserpermissionsApi();
            var id = 56;  // Integer |  (default to null)
            var id2 = 56;  // Integer |  (optional)  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)
            var username = username_example;  // String |  (optional)  (default to null)

            try {
                PaginatedFeedUserPermissionList result = apiInstance.userpermissionsSearchList(id, id2, limit, offset, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserpermissionsApi.userpermissionsSearchList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserpermissionsApi();
$id = 56; // Integer | 
$id2 = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.
$username = username_example; // String | 

try {
    $result = $api_instance->userpermissionsSearchList($id, $id2, $limit, $offset, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserpermissionsApi->userpermissionsSearchList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserpermissionsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserpermissionsApi->new();
my $id = 56; # Integer | 
my $id2 = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.
my $username = username_example; # String | 

eval {
    my $result = $api_instance->userpermissionsSearchList(id => $id, id2 => $id2, limit => $limit, offset => $offset, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserpermissionsApi->userpermissionsSearchList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UserpermissionsApi()
id = 56 # Integer |  (default to null)
id2 = 56 # Integer |  (optional) (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)
username = username_example # String |  (optional) (default to null)

try:
    api_response = api_instance.userpermissions_search_list(id, id2=id2, limit=limit, offset=offset, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserpermissionsApi->userpermissionsSearchList: %s\n" % e)
extern crate UserpermissionsApi;

pub fn main() {
    let id = 56; // Integer
    let id2 = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer
    let username = username_example; // String

    let mut context = UserpermissionsApi::Context::default();
    let result = client.userpermissionsSearchList(id, id2, limit, offset, username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
id
Integer
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.
username
String

Responses


Users

usersCreate


/api/v1/users/

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/users/" \
 -d '{
  "password" : "password",
  "is_staff" : true,
  "email" : "email",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UserRequest userRequest = ; // UserRequest | 

        try {
            User result = apiInstance.usersCreate(userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserRequest userRequest = new UserRequest(); // UserRequest | 

try {
    final result = await api_instance.usersCreate(userRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->usersCreate: $e\n');
}

import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserRequest userRequest = ; // UserRequest | 

        try {
            User result = apiInstance.usersCreate(userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UserRequest *userRequest = ; // 

[apiInstance usersCreateWith:userRequest
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UsersApi()
var userRequest = ; // {UserRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersCreate(userRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersCreateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var userRequest = new UserRequest(); // UserRequest | 

            try {
                User result = apiInstance.usersCreate(userRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$userRequest = ; // UserRequest | 

try {
    $result = $api_instance->usersCreate($userRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $userRequest = WWW::OPenAPIClient::Object::UserRequest->new(); # UserRequest | 

eval {
    my $result = $api_instance->usersCreate(userRequest => $userRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersCreate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UsersApi()
userRequest =  # UserRequest | 

try:
    api_response = api_instance.users_create(userRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersCreate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let userRequest = ; // UserRequest

    let mut context = UsersApi::Context::default();
    let result = client.usersCreate(userRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userRequest *

Responses


usersGroupsList

A view for a user-specific collection of groups.


/api/v1/users/{id}/groups/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/users/{id}/groups/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupList result = apiInstance.usersGroupsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersGroupsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.usersGroupsList(id, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->usersGroupsList: $e\n');
}

import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedGroupList result = apiInstance.usersGroupsList(id, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersGroupsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Integer *id = 56; //  (default to null)
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance usersGroupsListWith:id
    limit:limit
    offset:offset
              completionHandler: ^(PaginatedGroupList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UsersApi()
var id = 56; // {Integer} 
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersGroupsList(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersGroupsListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 56;  // Integer |  (default to null)
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedGroupList result = apiInstance.usersGroupsList(id, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersGroupsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 56; // Integer | 
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->usersGroupsList($id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersGroupsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 56; # Integer | 
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->usersGroupsList(id => $id, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersGroupsList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UsersApi()
id = 56 # Integer |  (default to null)
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.users_groups_list(id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersGroupsList: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 56; // Integer
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = UsersApi::Context::default();
    let result = client.usersGroupsList(id, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


usersList


/api/v1/users/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/users/?limit=56&offset=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedUserList result = apiInstance.usersList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | Number of results to return per page.
final Integer offset = new Integer(); // Integer | The initial index from which to return the results.

try {
    final result = await api_instance.usersList(limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->usersList: $e\n');
}

import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer limit = 56; // Integer | Number of results to return per page.
        Integer offset = 56; // Integer | The initial index from which to return the results.

        try {
            PaginatedUserList result = apiInstance.usersList(limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Integer *limit = 56; // Number of results to return per page. (optional) (default to null)
Integer *offset = 56; // The initial index from which to return the results. (optional) (default to null)

[apiInstance usersListWith:limit
    offset:offset
              completionHandler: ^(PaginatedUserList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UsersApi()
var opts = {
  'limit': 56, // {Integer} Number of results to return per page.
  'offset': 56 // {Integer} The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var limit = 56;  // Integer | Number of results to return per page. (optional)  (default to null)
            var offset = 56;  // Integer | The initial index from which to return the results. (optional)  (default to null)

            try {
                PaginatedUserList result = apiInstance.usersList(limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$limit = 56; // Integer | Number of results to return per page.
$offset = 56; // Integer | The initial index from which to return the results.

try {
    $result = $api_instance->usersList($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $limit = 56; # Integer | Number of results to return per page.
my $offset = 56; # Integer | The initial index from which to return the results.

eval {
    my $result = $api_instance->usersList(limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersList: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UsersApi()
limit = 56 # Integer | Number of results to return per page. (optional) (default to null)
offset = 56 # Integer | The initial index from which to return the results. (optional) (default to null)

try:
    api_response = api_instance.users_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersList: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer

    let mut context = UsersApi::Context::default();
    let result = client.usersList(limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
Integer
Number of results to return per page.
offset
Integer
The initial index from which to return the results.

Responses


usersRetrieve


/api/v1/users/{id}/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 "http://localhost/api/v1/users/{id}/"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 

        try {
            User result = apiInstance.usersRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersRetrieve");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.usersRetrieve(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->usersRetrieve: $e\n');
}

import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 

        try {
            User result = apiInstance.usersRetrieve(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersRetrieve");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance usersRetrieveWith:id
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UsersApi()
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.usersRetrieve(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersRetrieveExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 56;  // Integer |  (default to null)

            try {
                User result = apiInstance.usersRetrieve(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersRetrieve: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->usersRetrieve($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersRetrieve: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 56; # Integer | 

eval {
    my $result = $api_instance->usersRetrieve(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersRetrieve: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UsersApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.users_retrieve(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersRetrieve: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = UsersApi::Context::default();
    let result = client.usersRetrieve(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses


usersUpdate


/api/v1/users/{id}/

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Basic [[basicHash]]" \
-H "Authorization: [[apiKey]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data" \
 "http://localhost/api/v1/users/{id}/" \
 -d '{
  "password" : "password",
  "is_staff" : true,
  "email" : "email",
  "username" : "username"
}' \
 -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded' \
 -d 'Custom MIME type example not yet supported: multipart/form-data'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: tokenAuth
        ApiKeyAuth tokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("tokenAuth");
        tokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //tokenAuth.setApiKeyPrefix("Token");

        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        UserRequest userRequest = ; // UserRequest | 

        try {
            User result = apiInstance.usersUpdate(id, userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final UserRequest userRequest = new UserRequest(); // UserRequest | 

try {
    final result = await api_instance.usersUpdate(id, userRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->usersUpdate: $e\n');
}

import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        UserRequest userRequest = ; // UserRequest | 

        try {
            User result = apiInstance.usersUpdate(id, userRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure API key authorization: (authentication scheme: tokenAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sessionid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sessionid"];


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Integer *id = 56; //  (default to null)
UserRequest *userRequest = ; // 

[apiInstance usersUpdateWith:id
    userRequest:userRequest
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var ChRisResearchIntegrationSystemUltronBackEndCubeApi = require('ch_ris_research_integration_system_ultron_back_end__cube_api');
var defaultClient = ChRisResearchIntegrationSystemUltronBackEndCubeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token";

// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token";

// Create an instance of the API class
var api = new ChRisResearchIntegrationSystemUltronBackEndCubeApi.UsersApi()
var id = 56; // {Integer} 
var userRequest = ; // {UserRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersUpdate(id, userRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersUpdateExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure API key authorization: tokenAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("sessionid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sessionid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 56;  // Integer |  (default to null)
            var userRequest = new UserRequest(); // UserRequest | 

            try {
                User result = apiInstance.usersUpdate(id, userRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

// Configure API key authorization: tokenAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 56; // Integer | 
$userRequest = ; // UserRequest | 

try {
    $result = $api_instance->usersUpdate($id, $userRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;
# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

# Configure API key authorization: tokenAuth
$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sessionid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sessionid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 56; # Integer | 
my $userRequest = WWW::OPenAPIClient::Object::UserRequest->new(); # UserRequest | 

eval {
    my $result = $api_instance->usersUpdate(id => $id, userRequest => $userRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersUpdate: $@\n";
}
from __future__ import print_statement
import time
import chris_oag
from chris_oag.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
chris_oag.configuration.username = 'YOUR_USERNAME'
chris_oag.configuration.password = 'YOUR_PASSWORD'

# Configure API key authorization: tokenAuth
chris_oag.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API key authorization: cookieAuth
chris_oag.configuration.api_key['sessionid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# chris_oag.configuration.api_key_prefix['sessionid'] = 'Bearer'

# Create an instance of the API class
api_instance = chris_oag.UsersApi()
id = 56 # Integer |  (default to null)
userRequest =  # UserRequest | 

try:
    api_response = api_instance.users_update(id, userRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersUpdate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 56; // Integer
    let userRequest = ; // UserRequest

    let mut context = UsersApi::Context::default();
    let result = client.usersUpdate(id, userRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
userRequest *

Responses