Argos Service

Hierarchy

createLabel

create a new label


/label

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/label"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HierarchyApi apiInstance = new HierarchyApi();
        Label label = ; // Label | 
        try {
            Label result = apiInstance.createLabel(label);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#createLabel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        Label label = ; // Label | 
        try {
            Label result = apiInstance.createLabel(label);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#createLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

Label *label = ; //  (optional)

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

// create a new label
[apiInstance createLabelWith:label
              completionHandler: ^(Label output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.HierarchyApi()
var opts = {
  'label':  // {Label} 
};

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

namespace Example
{
    public class createLabelExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HierarchyApi();
            var label = new Label(); // Label |  (optional) 

            try
            {
                // create a new label
                Label result = apiInstance.createLabel(label);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.createLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HierarchyApi();
$label = ; // Label | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HierarchyApi->new();
my $label = WWW::OPenAPIClient::Object::Label->new(); # Label | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HierarchyApi()
label =  # Label |  (optional)

try: 
    # create a new label
    api_response = api_instance.create_label(label=label)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->createLabel: %s\n" % e)
extern crate HierarchyApi;

pub fn main() {
    let label = ; // Label

    let mut context = HierarchyApi::Context::default();
    let result = client.createLabel(label, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
label

{
Required: name
id:
undefined
name:
undefined
parentLabelId:
undefined

Responses

Status: 201 - created label

Name Type Format Description
Location URI uri location where the created label can be found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

deleteLabelById

delete label by id


/label/{labelId}

Usage and SDK Samples

curl -X DELETE -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/label/{labelId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HierarchyApi apiInstance = new HierarchyApi();
        String labelId = labelId_example; // String | label id
        try {
            apiInstance.deleteLabelById(labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#deleteLabelById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String labelId = labelId_example; // String | label id
        try {
            apiInstance.deleteLabelById(labelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#deleteLabelById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *labelId = labelId_example; // label id (default to null)

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

// delete label by id
[apiInstance deleteLabelByIdWith:labelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.HierarchyApi()
var labelId = labelId_example; // {String} label id

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

namespace Example
{
    public class deleteLabelByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HierarchyApi();
            var labelId = labelId_example;  // String | label id (default to null)

            try
            {
                // delete label by id
                apiInstance.deleteLabelById(labelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.deleteLabelById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HierarchyApi();
$labelId = labelId_example; // String | label id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HierarchyApi->new();
my $labelId = labelId_example; # String | label id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HierarchyApi()
labelId = labelId_example # String | label id (default to null)

try: 
    # delete label by id
    api_instance.delete_label_by_id(labelId)
except ApiException as e:
    print("Exception when calling HierarchyApi->deleteLabelById: %s\n" % e)
extern crate HierarchyApi;

pub fn main() {
    let labelId = labelId_example; // String

    let mut context = HierarchyApi::Context::default();
    let result = client.deleteLabelById(labelId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
labelId*
String

label id

Required

Responses

Status: 204 - label deleted

Status: 500 - server error

{
Required: message
message:
string

getLabelById

get label by id


/label/{labelId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/label/{labelId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HierarchyApi apiInstance = new HierarchyApi();
        String labelId = labelId_example; // String | label id
        try {
            Label result = apiInstance.getLabelById(labelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getLabelById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String labelId = labelId_example; // String | label id
        try {
            Label result = apiInstance.getLabelById(labelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getLabelById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *labelId = labelId_example; // label id (default to null)

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

// get label by id
[apiInstance getLabelByIdWith:labelId
              completionHandler: ^(Label output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.HierarchyApi()
var labelId = labelId_example; // {String} label id

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

namespace Example
{
    public class getLabelByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HierarchyApi();
            var labelId = labelId_example;  // String | label id (default to null)

            try
            {
                // get label by id
                Label result = apiInstance.getLabelById(labelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.getLabelById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HierarchyApi();
$labelId = labelId_example; // String | label id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HierarchyApi->new();
my $labelId = labelId_example; # String | label id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HierarchyApi()
labelId = labelId_example # String | label id (default to null)

try: 
    # get label by id
    api_response = api_instance.get_label_by_id(labelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->getLabelById: %s\n" % e)
extern crate HierarchyApi;

pub fn main() {
    let labelId = labelId_example; // String

    let mut context = HierarchyApi::Context::default();
    let result = client.getLabelById(labelId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
labelId*
String

label id

Required

Responses

Status: 200 - label

{
Required: name
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 500 - server error

{
Required: message
message:
string

getRootNodes

get all root nodes


/hierarchy

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/hierarchy?HierarchyMode=&maxDepth="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HierarchyApi apiInstance = new HierarchyApi();
        HierarchyMode hierarchyMode = ; // HierarchyMode | 
        Integer maxDepth = 56; // Integer | positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE
        try {
            array[TreeNode] result = apiInstance.getRootNodes(hierarchyMode, maxDepth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getRootNodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        HierarchyMode hierarchyMode = ; // HierarchyMode | 
        Integer maxDepth = 56; // Integer | positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE
        try {
            array[TreeNode] result = apiInstance.getRootNodes(hierarchyMode, maxDepth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getRootNodes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

HierarchyMode *hierarchyMode = ; //  (optional) (default to null)
Integer *maxDepth = 56; // positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE (optional) (default to 1)

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

// get all root nodes
[apiInstance getRootNodesWith:hierarchyMode
    maxDepth:maxDepth
              completionHandler: ^(array[TreeNode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.HierarchyApi()
var opts = {
  'hierarchyMode': , // {HierarchyMode} 
  'maxDepth': 56 // {Integer} positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE
};

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

namespace Example
{
    public class getRootNodesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HierarchyApi();
            var hierarchyMode = new HierarchyMode(); // HierarchyMode |  (optional)  (default to null)
            var maxDepth = 56;  // Integer | positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE (optional)  (default to 1)

            try
            {
                // get all root nodes
                array[TreeNode] result = apiInstance.getRootNodes(hierarchyMode, maxDepth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.getRootNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HierarchyApi();
$hierarchyMode = ; // HierarchyMode | 
$maxDepth = 56; // Integer | positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HierarchyApi->new();
my $hierarchyMode = ; # HierarchyMode | 
my $maxDepth = 56; # Integer | positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HierarchyApi()
hierarchyMode =  # HierarchyMode |  (optional) (default to null)
maxDepth = 56 # Integer | positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE (optional) (default to 1)

try: 
    # get all root nodes
    api_response = api_instance.get_root_nodes(hierarchyMode=hierarchyMode, maxDepth=maxDepth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->getRootNodes: %s\n" % e)
extern crate HierarchyApi;

pub fn main() {
    let hierarchyMode = ; // HierarchyMode
    let maxDepth = 56; // Integer

    let mut context = HierarchyApi::Context::default();
    let result = client.getRootNodes(hierarchyMode, maxDepth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
HierarchyMode
HierarchyMode
maxDepth
Integer (int32)

positive integer specifying the maximum levels of descendants that are returned in a search. This parameter is ignored in case of HierarchyhMode ALL and NONE

Responses

Status: 200 - list of nodes

[
{
Required: children,name,referenceId,type
name:
undefined
type:
string
Enum: LABEL, SUPPLY_CHAIN, SERVICE_ACCOUNT
referenceId:
undefined
hasChildren:
boolean
children:
[ (0..256)
undefined
]
permissions:
[ (0..256)
undefined
]
]

Status: 500 - server error

{
Required: message
message:
string

getSubTree

get a subtree


/hierarchy/{referenceId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/hierarchy/{referenceId}?HierarchyMode=&maxDepth="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HierarchyApi apiInstance = new HierarchyApi();
        String referenceId = referenceId_example; // String | this will be the root id of the returned sub tree
        HierarchyMode hierarchyMode = ; // HierarchyMode | 
        Integer maxDepth = 56; // Integer | positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE
        try {
            TreeNode result = apiInstance.getSubTree(referenceId, hierarchyMode, maxDepth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getSubTree");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String referenceId = referenceId_example; // String | this will be the root id of the returned sub tree
        HierarchyMode hierarchyMode = ; // HierarchyMode | 
        Integer maxDepth = 56; // Integer | positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE
        try {
            TreeNode result = apiInstance.getSubTree(referenceId, hierarchyMode, maxDepth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getSubTree");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *referenceId = referenceId_example; // this will be the root id of the returned sub tree (default to null)
HierarchyMode *hierarchyMode = ; //  (optional) (default to null)
Integer *maxDepth = 56; // positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE (optional) (default to 1)

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

// get a subtree
[apiInstance getSubTreeWith:referenceId
    hierarchyMode:hierarchyMode
    maxDepth:maxDepth
              completionHandler: ^(TreeNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.HierarchyApi()
var referenceId = referenceId_example; // {String} this will be the root id of the returned sub tree
var opts = {
  'hierarchyMode': , // {HierarchyMode} 
  'maxDepth': 56 // {Integer} positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE
};

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

namespace Example
{
    public class getSubTreeExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HierarchyApi();
            var referenceId = referenceId_example;  // String | this will be the root id of the returned sub tree (default to null)
            var hierarchyMode = new HierarchyMode(); // HierarchyMode |  (optional)  (default to null)
            var maxDepth = 56;  // Integer | positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE (optional)  (default to 1)

            try
            {
                // get a subtree
                TreeNode result = apiInstance.getSubTree(referenceId, hierarchyMode, maxDepth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.getSubTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HierarchyApi();
$referenceId = referenceId_example; // String | this will be the root id of the returned sub tree
$hierarchyMode = ; // HierarchyMode | 
$maxDepth = 56; // Integer | positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HierarchyApi->new();
my $referenceId = referenceId_example; # String | this will be the root id of the returned sub tree
my $hierarchyMode = ; # HierarchyMode | 
my $maxDepth = 56; # Integer | positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HierarchyApi()
referenceId = referenceId_example # String | this will be the root id of the returned sub tree (default to null)
hierarchyMode =  # HierarchyMode |  (optional) (default to null)
maxDepth = 56 # Integer | positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE (optional) (default to 1)

try: 
    # get a subtree
    api_response = api_instance.get_sub_tree(referenceId, hierarchyMode=hierarchyMode, maxDepth=maxDepth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->getSubTree: %s\n" % e)
extern crate HierarchyApi;

pub fn main() {
    let referenceId = referenceId_example; // String
    let hierarchyMode = ; // HierarchyMode
    let maxDepth = 56; // Integer

    let mut context = HierarchyApi::Context::default();
    let result = client.getSubTree(referenceId, hierarchyMode, maxDepth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
referenceId*
String

this will be the root id of the returned sub tree

Required
Query parameters
Name Description
HierarchyMode
HierarchyMode
maxDepth
Integer (int32)

positive integer specifying the maximum levels of descendants that are retured this parameter is ignored in case of HierarchyhMode ALL and NONE

Responses

Status: 200 - ok

{
Required: children,name,referenceId,type
name:
undefined
type:
string
Enum: LABEL, SUPPLY_CHAIN, SERVICE_ACCOUNT
referenceId:
undefined
hasChildren:
boolean
children:
[ (0..256)
undefined
]
permissions:
[ (0..256)
undefined
]

Status: 500 - server error

{
Required: message
message:
string

updateLabelById

update label by id


/label/{labelId}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/label/{labelId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HierarchyApi apiInstance = new HierarchyApi();
        String labelId = labelId_example; // String | label id
        Label label = ; // Label | 
        try {
            Label result = apiInstance.updateLabelById(labelId, label);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#updateLabelById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String labelId = labelId_example; // String | label id
        Label label = ; // Label | 
        try {
            Label result = apiInstance.updateLabelById(labelId, label);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#updateLabelById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *labelId = labelId_example; // label id (default to null)
Label *label = ; // 

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

// update label by id
[apiInstance updateLabelByIdWith:labelId
    label:label
              completionHandler: ^(Label output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.HierarchyApi()
var labelId = labelId_example; // {String} label id
var label = ; // {Label} 

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

namespace Example
{
    public class updateLabelByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HierarchyApi();
            var labelId = labelId_example;  // String | label id (default to null)
            var label = new Label(); // Label | 

            try
            {
                // update label by id
                Label result = apiInstance.updateLabelById(labelId, label);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.updateLabelById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HierarchyApi();
$labelId = labelId_example; // String | label id
$label = ; // Label | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HierarchyApi->new();
my $labelId = labelId_example; # String | label id
my $label = WWW::OPenAPIClient::Object::Label->new(); # Label | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HierarchyApi()
labelId = labelId_example # String | label id (default to null)
label =  # Label | 

try: 
    # update label by id
    api_response = api_instance.update_label_by_id(labelId, label)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->updateLabelById: %s\n" % e)
extern crate HierarchyApi;

pub fn main() {
    let labelId = labelId_example; // String
    let label = ; // Label

    let mut context = HierarchyApi::Context::default();
    let result = client.updateLabelById(labelId, label, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
labelId*
String

label id

Required
Body parameters
Name Description
label *

{
Required: name
id:
undefined
name:
undefined
parentLabelId:
undefined

Responses

Status: 200 - created label

{
Required: name
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

Layout

createApprovalConfigurations

create approval configurations for a layout


/supplychain/{supplyChainId}/layout/approvalconfig

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout/approvalconfig"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        array[ApprovalConfiguration] approvalConfiguration = ; // array[ApprovalConfiguration] | 
        try {
            array[ApprovalConfiguration] result = apiInstance.createApprovalConfigurations(supplyChainId, approvalConfiguration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#createApprovalConfigurations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        array[ApprovalConfiguration] approvalConfiguration = ; // array[ApprovalConfiguration] | 
        try {
            array[ApprovalConfiguration] result = apiInstance.createApprovalConfigurations(supplyChainId, approvalConfiguration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#createApprovalConfigurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
array[ApprovalConfiguration] *approvalConfiguration = ; // 

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

// create approval configurations for a layout
[apiInstance createApprovalConfigurationsWith:supplyChainId
    approvalConfiguration:approvalConfiguration
              completionHandler: ^(array[ApprovalConfiguration] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var approvalConfiguration = ; // {array[ApprovalConfiguration]} 

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

namespace Example
{
    public class createApprovalConfigurationsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var approvalConfiguration = new array[ApprovalConfiguration](); // array[ApprovalConfiguration] | 

            try
            {
                // create approval configurations for a layout
                array[ApprovalConfiguration] result = apiInstance.createApprovalConfigurations(supplyChainId, approvalConfiguration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.createApprovalConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$approvalConfiguration = ; // array[ApprovalConfiguration] | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $approvalConfiguration = [WWW::OPenAPIClient::Object::array[ApprovalConfiguration]->new()]; # array[ApprovalConfiguration] | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
approvalConfiguration =  # array[ApprovalConfiguration] | 

try: 
    # create approval configurations for a layout
    api_response = api_instance.create_approval_configurations(supplyChainId, approvalConfiguration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->createApprovalConfigurations: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let approvalConfiguration = ; // array[ApprovalConfiguration]

    let mut context = LayoutApi::Context::default();
    let result = client.createApprovalConfigurations(supplyChainId, approvalConfiguration, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
approvalConfiguration *

[ (0..20)
undefined
]

Responses

Status: 200 - ok

[
{
Required: artifactCollectorSpecifications,segmentName,stepName
stepName:
undefined
segmentName:
undefined
artifactCollectorSpecifications:
[ (1..20)
undefined
]
]

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

createOrUpdateLayout

create or update a layout


/supplychain/{supplyChainId}/layout

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        LayoutMetaBlock layoutMetaBlock = ; // LayoutMetaBlock | 
        try {
            LayoutMetaBlock result = apiInstance.createOrUpdateLayout(supplyChainId, layoutMetaBlock);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#createOrUpdateLayout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        LayoutMetaBlock layoutMetaBlock = ; // LayoutMetaBlock | 
        try {
            LayoutMetaBlock result = apiInstance.createOrUpdateLayout(supplyChainId, layoutMetaBlock);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#createOrUpdateLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
LayoutMetaBlock *layoutMetaBlock = ; // 

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

// create or update a layout
[apiInstance createOrUpdateLayoutWith:supplyChainId
    layoutMetaBlock:layoutMetaBlock
              completionHandler: ^(LayoutMetaBlock output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var layoutMetaBlock = ; // {LayoutMetaBlock} 

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

namespace Example
{
    public class createOrUpdateLayoutExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var layoutMetaBlock = new LayoutMetaBlock(); // LayoutMetaBlock | 

            try
            {
                // create or update a layout
                LayoutMetaBlock result = apiInstance.createOrUpdateLayout(supplyChainId, layoutMetaBlock);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.createOrUpdateLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$layoutMetaBlock = ; // LayoutMetaBlock | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $layoutMetaBlock = WWW::OPenAPIClient::Object::LayoutMetaBlock->new(); # LayoutMetaBlock | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
layoutMetaBlock =  # LayoutMetaBlock | 

try: 
    # create or update a layout
    api_response = api_instance.create_or_update_layout(supplyChainId, layoutMetaBlock)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->createOrUpdateLayout: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let layoutMetaBlock = ; // LayoutMetaBlock

    let mut context = LayoutApi::Context::default();
    let result = client.createOrUpdateLayout(supplyChainId, layoutMetaBlock, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
layoutMetaBlock *

{
Required: layout,signatures
signatures:
[ (1..20)
undefined
]
layout:
undefined

Responses

Status: 201 - created

Name Type Format Description
Location URI uri location where the created layout metablock can be found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

createReleaseConfiguration

create release configurations for a layout


/supplychain/{supplyChainId}/layout/releaseconfig

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout/releaseconfig"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        ReleaseConfiguration releaseConfiguration = ; // ReleaseConfiguration | 
        try {
            ReleaseConfiguration result = apiInstance.createReleaseConfiguration(supplyChainId, releaseConfiguration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#createReleaseConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        ReleaseConfiguration releaseConfiguration = ; // ReleaseConfiguration | 
        try {
            ReleaseConfiguration result = apiInstance.createReleaseConfiguration(supplyChainId, releaseConfiguration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#createReleaseConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
ReleaseConfiguration *releaseConfiguration = ; // 

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

// create release configurations for a layout
[apiInstance createReleaseConfigurationWith:supplyChainId
    releaseConfiguration:releaseConfiguration
              completionHandler: ^(ReleaseConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var releaseConfiguration = ; // {ReleaseConfiguration} 

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

namespace Example
{
    public class createReleaseConfigurationExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var releaseConfiguration = new ReleaseConfiguration(); // ReleaseConfiguration | 

            try
            {
                // create release configurations for a layout
                ReleaseConfiguration result = apiInstance.createReleaseConfiguration(supplyChainId, releaseConfiguration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.createReleaseConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$releaseConfiguration = ; // ReleaseConfiguration | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $releaseConfiguration = WWW::OPenAPIClient::Object::ReleaseConfiguration->new(); # ReleaseConfiguration | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
releaseConfiguration =  # ReleaseConfiguration | 

try: 
    # create release configurations for a layout
    api_response = api_instance.create_release_configuration(supplyChainId, releaseConfiguration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->createReleaseConfiguration: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let releaseConfiguration = ; // ReleaseConfiguration

    let mut context = LayoutApi::Context::default();
    let result = client.createReleaseConfiguration(supplyChainId, releaseConfiguration, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
releaseConfiguration *

{
Required: artifactCollectorSpecifications
artifactCollectorSpecifications:
[ (0..20)
undefined
]

Responses

Status: 200 - ok

{
Required: artifactCollectorSpecifications
artifactCollectorSpecifications:
[ (0..20)
undefined
]

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

getApprovalConfigurations

returns a list of approval configurations for a layout


/supplychain/{supplyChainId}/layout/approvalconfig

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout/approvalconfig"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            array[ApprovalConfiguration] result = apiInstance.getApprovalConfigurations(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getApprovalConfigurations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            array[ApprovalConfiguration] result = apiInstance.getApprovalConfigurations(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getApprovalConfigurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)

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

// returns a list of approval configurations for a layout
[apiInstance getApprovalConfigurationsWith:supplyChainId
              completionHandler: ^(array[ApprovalConfiguration] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id

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

namespace Example
{
    public class getApprovalConfigurationsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)

            try
            {
                // returns a list of approval configurations for a layout
                array[ApprovalConfiguration] result = apiInstance.getApprovalConfigurations(supplyChainId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.getApprovalConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)

try: 
    # returns a list of approval configurations for a layout
    api_response = api_instance.get_approval_configurations(supplyChainId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->getApprovalConfigurations: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String

    let mut context = LayoutApi::Context::default();
    let result = client.getApprovalConfigurations(supplyChainId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required

Responses

Status: 200 - array of approval configurations

[
{
Required: artifactCollectorSpecifications,segmentName,stepName
stepName:
undefined
segmentName:
undefined
artifactCollectorSpecifications:
[ (1..20)
undefined
]
]

Status: 500 - server error

{
Required: message
message:
string

getApprovalsForAccount

returns a list of approvals for the login user


/supplychain/{supplyChainId}/layout/approvalconfig/me

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout/approvalconfig/me"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            array[ApprovalConfiguration] result = apiInstance.getApprovalsForAccount(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getApprovalsForAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            array[ApprovalConfiguration] result = apiInstance.getApprovalsForAccount(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getApprovalsForAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)

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

// returns a list of approvals for the login user
[apiInstance getApprovalsForAccountWith:supplyChainId
              completionHandler: ^(array[ApprovalConfiguration] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id

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

namespace Example
{
    public class getApprovalsForAccountExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)

            try
            {
                // returns a list of approvals for the login user
                array[ApprovalConfiguration] result = apiInstance.getApprovalsForAccount(supplyChainId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.getApprovalsForAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)

try: 
    # returns a list of approvals for the login user
    api_response = api_instance.get_approvals_for_account(supplyChainId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->getApprovalsForAccount: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String

    let mut context = LayoutApi::Context::default();
    let result = client.getApprovalsForAccount(supplyChainId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required

Responses

Status: 200 - array of approvals

[
{
Required: artifactCollectorSpecifications,segmentName,stepName
stepName:
undefined
segmentName:
undefined
artifactCollectorSpecifications:
[ (1..20)
undefined
]
]

Status: 500 - server error

{
Required: message
message:
string

getLayout

get layout


/supplychain/{supplyChainId}/layout

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            LayoutMetaBlock result = apiInstance.getLayout(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getLayout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            LayoutMetaBlock result = apiInstance.getLayout(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)

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

// get layout
[apiInstance getLayoutWith:supplyChainId
              completionHandler: ^(LayoutMetaBlock output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id

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

namespace Example
{
    public class getLayoutExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)

            try
            {
                // get layout
                LayoutMetaBlock result = apiInstance.getLayout(supplyChainId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.getLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)

try: 
    # get layout
    api_response = api_instance.get_layout(supplyChainId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->getLayout: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String

    let mut context = LayoutApi::Context::default();
    let result = client.getLayout(supplyChainId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required

Responses

Status: 200 - layout

{
Required: layout,signatures
signatures:
[ (1..20)
undefined
]
layout:
undefined

Status: 500 - server error

{
Required: message
message:
string

Status: 404 - no layout found


getReleaseConfiguration

returns release configurations for a layout


/supplychain/{supplyChainId}/layout/releaseconfig

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout/releaseconfig"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            ReleaseConfiguration result = apiInstance.getReleaseConfiguration(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getReleaseConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            ReleaseConfiguration result = apiInstance.getReleaseConfiguration(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#getReleaseConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)

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

// returns release configurations for a layout
[apiInstance getReleaseConfigurationWith:supplyChainId
              completionHandler: ^(ReleaseConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id

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

namespace Example
{
    public class getReleaseConfigurationExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)

            try
            {
                // returns release configurations for a layout
                ReleaseConfiguration result = apiInstance.getReleaseConfiguration(supplyChainId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.getReleaseConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)

try: 
    # returns release configurations for a layout
    api_response = api_instance.get_release_configuration(supplyChainId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LayoutApi->getReleaseConfiguration: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String

    let mut context = LayoutApi::Context::default();
    let result = client.getReleaseConfiguration(supplyChainId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required

Responses

Status: 200 - release configuration

{
Required: artifactCollectorSpecifications
artifactCollectorSpecifications:
[ (0..20)
undefined
]

Status: 500 - server error

{
Required: message
message:
string

validateLayout

validates a layout on data input and model consistency


/supplychain/{supplyChainId}/layout/validate

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/layout/validate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        Layout layout = ; // Layout | 
        try {
            apiInstance.validateLayout(supplyChainId, layout);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#validateLayout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        Layout layout = ; // Layout | 
        try {
            apiInstance.validateLayout(supplyChainId, layout);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#validateLayout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
Layout *layout = ; // 

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

// validates a layout on data input and model consistency
[apiInstance validateLayoutWith:supplyChainId
    layout:layout
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.LayoutApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var layout = ; // {Layout} 

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

namespace Example
{
    public class validateLayoutExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LayoutApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var layout = new Layout(); // Layout | 

            try
            {
                // validates a layout on data input and model consistency
                apiInstance.validateLayout(supplyChainId, layout);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.validateLayout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\LayoutApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$layout = ; // Layout | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::LayoutApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $layout = WWW::OPenAPIClient::Object::Layout->new(); # Layout | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.LayoutApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
layout =  # Layout | 

try: 
    # validates a layout on data input and model consistency
    api_instance.validate_layout(supplyChainId, layout)
except ApiException as e:
    print("Exception when calling LayoutApi->validateLayout: %s\n" % e)
extern crate LayoutApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let layout = ; // Layout

    let mut context = LayoutApi::Context::default();
    let result = client.validateLayout(supplyChainId, layout, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
layout *

{
Required: authorizedKeyIds,expectedEndProducts,keys,layoutSegments
keys:
[ (1..256)
undefined
]
authorizedKeyIds:
[ (1..256)
undefined
]
expectedEndProducts:
[ (1..4096)
undefined
]
layoutSegments:
[ (1..256)
undefined
]

Responses

Status: 204 - layout is correct

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

OauthProvider

getOAuthProviders

get a list of configured oauth providers


/oauthprovider

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/oauthprovider"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OauthProviderApi;

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

public class OauthProviderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        OauthProviderApi apiInstance = new OauthProviderApi();
        try {
            array[OAuthProvider] result = apiInstance.getOAuthProviders();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OauthProviderApi#getOAuthProviders");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OauthProviderApi;

public class OauthProviderApiExample {

    public static void main(String[] args) {
        OauthProviderApi apiInstance = new OauthProviderApi();
        try {
            array[OAuthProvider] result = apiInstance.getOAuthProviders();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OauthProviderApi#getOAuthProviders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// get a list of configured oauth providers
[apiInstance getOAuthProvidersWithCompletionHandler: 
              ^(array[OAuthProvider] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class getOAuthProvidersExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new OauthProviderApi();

            try
            {
                // get a list of configured oauth providers
                array[OAuthProvider] result = apiInstance.getOAuthProviders();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OauthProviderApi.getOAuthProviders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\OauthProviderApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::OauthProviderApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.OauthProviderApi()

try: 
    # get a list of configured oauth providers
    api_response = api_instance.get_o_auth_providers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OauthProviderApi->getOAuthProviders: %s\n" % e)
extern crate OauthProviderApi;

pub fn main() {

    let mut context = OauthProviderApi::Context::default();
    let result = client.getOAuthProviders(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - array of OAuthProviders

[ (0..20)
{
providerName:
string
displayName:
string
iconUrl:
string
]

Status: 500 - server error

{
Required: message
message:
string

Permissions

getPermissions

gets all permissions


/permissions

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/permissions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PermissionsApi;

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

public class PermissionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PermissionsApi apiInstance = new PermissionsApi();
        try {
            array[Permission] result = apiInstance.getPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getPermissions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        try {
            array[Permission] result = apiInstance.getPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// gets all permissions
[apiInstance getPermissionsWithCompletionHandler: 
              ^(array[Permission] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class getPermissionsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PermissionsApi();

            try
            {
                // gets all permissions
                array[Permission] result = apiInstance.getPermissions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.getPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PermissionsApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PermissionsApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PermissionsApi()

try: 
    # gets all permissions
    api_response = api_instance.get_permissions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->getPermissions: %s\n" % e)
extern crate PermissionsApi;

pub fn main() {

    let mut context = PermissionsApi::Context::default();
    let result = client.getPermissions(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - list of all permissions

[
string
Enum: READ, TREE_EDIT, LOCAL_PERMISSION_EDIT, ASSIGN_ROLE, LINK_ADD, LAYOUT_ADD, VERIFY, RELEASE, PERSONAL_ACCOUNT_READ, SERVICE_ACCOUNT_EDIT
]

Status: 401 - unauthorized

Status: 500 - server error

{
Required: message
message:
string

getRoles

gets all roles


/permissions/global/role

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/permissions/global/role"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PermissionsApi;

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

public class PermissionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PermissionsApi apiInstance = new PermissionsApi();
        try {
            array[Role] result = apiInstance.getRoles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getRoles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        try {
            array[Role] result = apiInstance.getRoles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getRoles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// gets all roles
[apiInstance getRolesWithCompletionHandler: 
              ^(array[Role] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class getRolesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PermissionsApi();

            try
            {
                // gets all roles
                array[Role] result = apiInstance.getRoles();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.getRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PermissionsApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PermissionsApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PermissionsApi()

try: 
    # gets all roles
    api_response = api_instance.get_roles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->getRoles: %s\n" % e)
extern crate PermissionsApi;

pub fn main() {

    let mut context = PermissionsApi::Context::default();
    let result = client.getRoles(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - list of roles

[
{
Required: name
id:
undefined
name:
undefined
permissions:
[ (1..20)
undefined
]
]

Status: 401 - unauthorized

Status: 500 - server error

{
Required: message
message:
string

PersonalAccount

createKey

creates a new active public and private key pair


/personalaccount/me/key

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/me/key"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        KeyPair keyPair = ; // KeyPair | 
        try {
            apiInstance.createKey(keyPair);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#createKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        KeyPair keyPair = ; // KeyPair | 
        try {
            apiInstance.createKey(keyPair);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#createKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

KeyPair *keyPair = ; // 

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

// creates a new active public and private key pair
[apiInstance createKeyWith:keyPair
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var keyPair = ; // {KeyPair} 

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

namespace Example
{
    public class createKeyExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var keyPair = new KeyPair(); // KeyPair | 

            try
            {
                // creates a new active public and private key pair
                apiInstance.createKey(keyPair);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.createKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$keyPair = ; // KeyPair | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $keyPair = WWW::OPenAPIClient::Object::KeyPair->new(); # KeyPair | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
keyPair =  # KeyPair | 

try: 
    # creates a new active public and private key pair
    api_instance.create_key(keyPair)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->createKey: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let keyPair = ; // KeyPair

    let mut context = PersonalAccountApi::Context::default();
    let result = client.createKey(keyPair, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
keyPair *

{
Required: encryptedPrivateKey,keyId,publicKey
keyId:
undefined
publicKey:
undefined
encryptedPrivateKey:
undefined

Responses

Status: 204 - no content

Status: 404 - personal account not found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

getAllLocalPermissions

returns all the local permissions of the personalaccount


/personalaccount/{accountId}/localpermission

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/{accountId}/localpermission"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        try {
            array[LocalPermissions] result = apiInstance.getAllLocalPermissions(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getAllLocalPermissions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        try {
            array[LocalPermissions] result = apiInstance.getAllLocalPermissions(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getAllLocalPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountId = accountId_example; //  (default to null)

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

// returns all the local permissions of the personalaccount
[apiInstance getAllLocalPermissionsWith:accountId
              completionHandler: ^(array[LocalPermissions] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var accountId = accountId_example; // {String} 

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

namespace Example
{
    public class getAllLocalPermissionsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var accountId = accountId_example;  // String |  (default to null)

            try
            {
                // returns all the local permissions of the personalaccount
                array[LocalPermissions] result = apiInstance.getAllLocalPermissions(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.getAllLocalPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$accountId = accountId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $accountId = accountId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
accountId = accountId_example # String |  (default to null)

try: 
    # returns all the local permissions of the personalaccount
    api_response = api_instance.get_all_local_permissions(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->getAllLocalPermissions: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let accountId = accountId_example; // String

    let mut context = PersonalAccountApi::Context::default();
    let result = client.getAllLocalPermissions(accountId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Required

Responses

Status: 200 - all local permissions

[
{
Required: labelId,permissions
labelId:
undefined
permissions:
[ (0..20)
undefined
]
]

Status: 500 - server error

{
Required: message
message:
string

getKeyPair

gets the currently active a key pair


/personalaccount/me/key

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/me/key"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            KeyPair result = apiInstance.getKeyPair();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getKeyPair");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            KeyPair result = apiInstance.getKeyPair();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getKeyPair");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// gets the currently active a key pair
[apiInstance getKeyPairWithCompletionHandler: 
              ^(KeyPair output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class getKeyPairExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();

            try
            {
                // gets the currently active a key pair
                KeyPair result = apiInstance.getKeyPair();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.getKeyPair: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()

try: 
    # gets the currently active a key pair
    api_response = api_instance.get_key_pair()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->getKeyPair: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {

    let mut context = PersonalAccountApi::Context::default();
    let result = client.getKeyPair(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - Key pair

{
Required: encryptedPrivateKey,keyId,publicKey
keyId:
undefined
publicKey:
undefined
encryptedPrivateKey:
undefined

Status: 404 - personal account not found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

getLocalPermissionsForLabel

returns the local permissions of the personalaccount and label


/personalaccount/{accountId}/localpermission/{labelId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/{accountId}/localpermission/{labelId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        String labelId = labelId_example; // String | 
        try {
            LocalPermissions result = apiInstance.getLocalPermissionsForLabel(accountId, labelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getLocalPermissionsForLabel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        String labelId = labelId_example; // String | 
        try {
            LocalPermissions result = apiInstance.getLocalPermissionsForLabel(accountId, labelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getLocalPermissionsForLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountId = accountId_example; //  (default to null)
String *labelId = labelId_example; //  (default to null)

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

// returns the local permissions of the personalaccount and label
[apiInstance getLocalPermissionsForLabelWith:accountId
    labelId:labelId
              completionHandler: ^(LocalPermissions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var accountId = accountId_example; // {String} 
var labelId = labelId_example; // {String} 

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

namespace Example
{
    public class getLocalPermissionsForLabelExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var accountId = accountId_example;  // String |  (default to null)
            var labelId = labelId_example;  // String |  (default to null)

            try
            {
                // returns the local permissions of the personalaccount and label
                LocalPermissions result = apiInstance.getLocalPermissionsForLabel(accountId, labelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.getLocalPermissionsForLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$accountId = accountId_example; // String | 
$labelId = labelId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $accountId = accountId_example; # String | 
my $labelId = labelId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
accountId = accountId_example # String |  (default to null)
labelId = labelId_example # String |  (default to null)

try: 
    # returns the local permissions of the personalaccount and label
    api_response = api_instance.get_local_permissions_for_label(accountId, labelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->getLocalPermissionsForLabel: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let accountId = accountId_example; // String
    let labelId = labelId_example; // String

    let mut context = PersonalAccountApi::Context::default();
    let result = client.getLocalPermissionsForLabel(accountId, labelId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Required
labelId*
String
Required

Responses

Status: 200 - local permissions

{
Required: labelId,permissions
labelId:
undefined
permissions:
[ (0..20)
undefined
]

Status: 204 - no local permissions


getPersonalAccountById

get personal account by id


/personalaccount/{accountId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/{accountId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        try {
            PersonalAccount result = apiInstance.getPersonalAccountById(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getPersonalAccountById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        try {
            PersonalAccount result = apiInstance.getPersonalAccountById(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getPersonalAccountById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountId = accountId_example; //  (default to null)

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

// get personal account by id
[apiInstance getPersonalAccountByIdWith:accountId
              completionHandler: ^(PersonalAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var accountId = accountId_example; // {String} 

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

namespace Example
{
    public class getPersonalAccountByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var accountId = accountId_example;  // String |  (default to null)

            try
            {
                // get personal account by id
                PersonalAccount result = apiInstance.getPersonalAccountById(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.getPersonalAccountById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$accountId = accountId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $accountId = accountId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
accountId = accountId_example # String |  (default to null)

try: 
    # get personal account by id
    api_response = api_instance.get_personal_account_by_id(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->getPersonalAccountById: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let accountId = accountId_example; // String

    let mut context = PersonalAccountApi::Context::default();
    let result = client.getPersonalAccountById(accountId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Required

Responses

Status: 200 - personal account

{
id:
undefined
name:
string maxLength:1024
roles:
[ (0..20)
undefined
]

Status: 500 - server error

{
Required: message
message:
string

getPersonalAccountKeyById

get active key by personal account id


/personalaccount/{accountId}/key

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/{accountId}/key"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        try {
            PublicKey result = apiInstance.getPersonalAccountKeyById(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getPersonalAccountKeyById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        try {
            PublicKey result = apiInstance.getPersonalAccountKeyById(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getPersonalAccountKeyById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountId = accountId_example; //  (default to null)

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

// get active key by personal account id
[apiInstance getPersonalAccountKeyByIdWith:accountId
              completionHandler: ^(PublicKey output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var accountId = accountId_example; // {String} 

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

namespace Example
{
    public class getPersonalAccountKeyByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var accountId = accountId_example;  // String |  (default to null)

            try
            {
                // get active key by personal account id
                PublicKey result = apiInstance.getPersonalAccountKeyById(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.getPersonalAccountKeyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$accountId = accountId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $accountId = accountId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
accountId = accountId_example # String |  (default to null)

try: 
    # get active key by personal account id
    api_response = api_instance.get_personal_account_key_by_id(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->getPersonalAccountKeyById: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let accountId = accountId_example; // String

    let mut context = PersonalAccountApi::Context::default();
    let result = client.getPersonalAccountKeyById(accountId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Required

Responses

Status: 200 - key

{
Required: keyId,publicKey
keyId:
undefined
publicKey:
undefined

Status: 404 - no active key exists

Status: 500 - server error

{
Required: message
message:
string

getPersonalAccountOfAuthenticatedUser

returns the personal account profile of the authenticated personal account based on the bearer token


/personalaccount/me

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/me"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            Profile result = apiInstance.getPersonalAccountOfAuthenticatedUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getPersonalAccountOfAuthenticatedUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            Profile result = apiInstance.getPersonalAccountOfAuthenticatedUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#getPersonalAccountOfAuthenticatedUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// returns the personal account profile of the authenticated personal account based on the bearer token
[apiInstance getPersonalAccountOfAuthenticatedUserWithCompletionHandler: 
              ^(Profile output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class getPersonalAccountOfAuthenticatedUserExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();

            try
            {
                // returns the personal account profile of the authenticated personal account based on the bearer token
                Profile result = apiInstance.getPersonalAccountOfAuthenticatedUser();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.getPersonalAccountOfAuthenticatedUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()

try: 
    # returns the personal account profile of the authenticated personal account based on the bearer token
    api_response = api_instance.get_personal_account_of_authenticated_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->getPersonalAccountOfAuthenticatedUser: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {

    let mut context = PersonalAccountApi::Context::default();
    let result = client.getPersonalAccountOfAuthenticatedUser(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - Personal Account Profile

{
id:
undefined
name:
string maxLength:1024
email:
string maxLength:1024
roles:
[ (0..20)
undefined
]

Status: 404 - personal account not found

Status: 500 - server error

{
Required: message
message:
string

logout

logout


/personalaccount/me/logout

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/me/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#logout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#logout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// logout
[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();

            try
            {
                // logout
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()

try: 
    # logout
    api_instance.logout()
except ApiException as e:
    print("Exception when calling PersonalAccountApi->logout: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {

    let mut context = PersonalAccountApi::Context::default();
    let result = client.logout(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 204 - logged out

Status: 500 - server error

{
Required: message
message:
string

refreshToken

refresh token


/personalaccount/me/refresh

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/me/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            Token result = apiInstance.refreshToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#refreshToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        try {
            Token result = apiInstance.refreshToken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#refreshToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// refresh token
[apiInstance refreshTokenWithCompletionHandler: 
              ^(Token output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class refreshTokenExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();

            try
            {
                // refresh token
                Token result = apiInstance.refreshToken();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.refreshToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()

try: 
    # refresh token
    api_response = api_instance.refresh_token()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->refreshToken: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {

    let mut context = PersonalAccountApi::Context::default();
    let result = client.refreshToken(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - new token

{
Required: token
token:
string

Status: 500 - server error

{
Required: message
message:
string

searchPersonalAccounts

search


/personalaccount

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount?roleName=&localPermissionsLabelId=&name=&activeKeyIds=&inactiveKeyIds="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String roleName = roleName_example; // String | 
        String localPermissionsLabelId = localPermissionsLabelId_example; // String | 
        String name = name_example; // String | 
        array[String] activeKeyIds = ; // array[String] | 
        array[String] inactiveKeyIds = ; // array[String] | 
        try {
            array[PersonalAccount] result = apiInstance.searchPersonalAccounts(roleName, localPermissionsLabelId, name, activeKeyIds, inactiveKeyIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#searchPersonalAccounts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String roleName = roleName_example; // String | 
        String localPermissionsLabelId = localPermissionsLabelId_example; // String | 
        String name = name_example; // String | 
        array[String] activeKeyIds = ; // array[String] | 
        array[String] inactiveKeyIds = ; // array[String] | 
        try {
            array[PersonalAccount] result = apiInstance.searchPersonalAccounts(roleName, localPermissionsLabelId, name, activeKeyIds, inactiveKeyIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#searchPersonalAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *roleName = roleName_example; //  (optional) (default to null)
String *localPermissionsLabelId = localPermissionsLabelId_example; //  (optional) (default to null)
String *name = name_example; //  (optional) (default to null)
array[String] *activeKeyIds = ; //  (optional) (default to null)
array[String] *inactiveKeyIds = ; //  (optional) (default to null)

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

// search
[apiInstance searchPersonalAccountsWith:roleName
    localPermissionsLabelId:localPermissionsLabelId
    name:name
    activeKeyIds:activeKeyIds
    inactiveKeyIds:inactiveKeyIds
              completionHandler: ^(array[PersonalAccount] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var opts = {
  'roleName': roleName_example, // {String} 
  'localPermissionsLabelId': localPermissionsLabelId_example, // {String} 
  'name': name_example, // {String} 
  'activeKeyIds': , // {array[String]} 
  'inactiveKeyIds':  // {array[String]} 
};

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

namespace Example
{
    public class searchPersonalAccountsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var roleName = roleName_example;  // String |  (optional)  (default to null)
            var localPermissionsLabelId = localPermissionsLabelId_example;  // String |  (optional)  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var activeKeyIds = new array[String](); // array[String] |  (optional)  (default to null)
            var inactiveKeyIds = new array[String](); // array[String] |  (optional)  (default to null)

            try
            {
                // search
                array[PersonalAccount] result = apiInstance.searchPersonalAccounts(roleName, localPermissionsLabelId, name, activeKeyIds, inactiveKeyIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.searchPersonalAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$roleName = roleName_example; // String | 
$localPermissionsLabelId = localPermissionsLabelId_example; // String | 
$name = name_example; // String | 
$activeKeyIds = ; // array[String] | 
$inactiveKeyIds = ; // array[String] | 

try {
    $result = $api_instance->searchPersonalAccounts($roleName, $localPermissionsLabelId, $name, $activeKeyIds, $inactiveKeyIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalAccountApi->searchPersonalAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PersonalAccountApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $roleName = roleName_example; # String | 
my $localPermissionsLabelId = localPermissionsLabelId_example; # String | 
my $name = name_example; # String | 
my $activeKeyIds = []; # array[String] | 
my $inactiveKeyIds = []; # array[String] | 

eval { 
    my $result = $api_instance->searchPersonalAccounts(roleName => $roleName, localPermissionsLabelId => $localPermissionsLabelId, name => $name, activeKeyIds => $activeKeyIds, inactiveKeyIds => $inactiveKeyIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalAccountApi->searchPersonalAccounts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
roleName = roleName_example # String |  (optional) (default to null)
localPermissionsLabelId = localPermissionsLabelId_example # String |  (optional) (default to null)
name = name_example # String |  (optional) (default to null)
activeKeyIds =  # array[String] |  (optional) (default to null)
inactiveKeyIds =  # array[String] |  (optional) (default to null)

try: 
    # search
    api_response = api_instance.search_personal_accounts(roleName=roleName, localPermissionsLabelId=localPermissionsLabelId, name=name, activeKeyIds=activeKeyIds, inactiveKeyIds=inactiveKeyIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->searchPersonalAccounts: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let roleName = roleName_example; // String
    let localPermissionsLabelId = localPermissionsLabelId_example; // String
    let name = name_example; // String
    let activeKeyIds = ; // array[String]
    let inactiveKeyIds = ; // array[String]

    let mut context = PersonalAccountApi::Context::default();
    let result = client.searchPersonalAccounts(roleName, localPermissionsLabelId, name, activeKeyIds, inactiveKeyIds, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
roleName
String
localPermissionsLabelId
String
name
String
activeKeyIds
array[String]
inactiveKeyIds
array[String]

Responses

Status: 200 - list of personal accounts without roles property

[
{
id:
undefined
name:
string maxLength:1024
roles:
[ (0..20)
undefined
]
]

updateLocalPermissionsForLabel

updates permissions of the personalaccount and label when the permissions list is empty the permissions are removed


/personalaccount/{accountId}/localpermission/{labelId}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/{accountId}/localpermission/{labelId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        String labelId = labelId_example; // String | 
        array[Permission] permission = ; // array[Permission] | 
        try {
            LocalPermissions result = apiInstance.updateLocalPermissionsForLabel(accountId, labelId, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#updateLocalPermissionsForLabel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        String labelId = labelId_example; // String | 
        array[Permission] permission = ; // array[Permission] | 
        try {
            LocalPermissions result = apiInstance.updateLocalPermissionsForLabel(accountId, labelId, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#updateLocalPermissionsForLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountId = accountId_example; //  (default to null)
String *labelId = labelId_example; //  (default to null)
array[Permission] *permission = ; // 

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

// updates permissions of the personalaccount and label when the permissions list is empty the permissions are removed
[apiInstance updateLocalPermissionsForLabelWith:accountId
    labelId:labelId
    permission:permission
              completionHandler: ^(LocalPermissions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var accountId = accountId_example; // {String} 
var labelId = labelId_example; // {String} 
var permission = ; // {array[Permission]} 

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

namespace Example
{
    public class updateLocalPermissionsForLabelExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var accountId = accountId_example;  // String |  (default to null)
            var labelId = labelId_example;  // String |  (default to null)
            var permission = new array[Permission](); // array[Permission] | 

            try
            {
                // updates permissions of the personalaccount and label when the permissions list is empty the permissions are removed
                LocalPermissions result = apiInstance.updateLocalPermissionsForLabel(accountId, labelId, permission);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.updateLocalPermissionsForLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$accountId = accountId_example; // String | 
$labelId = labelId_example; // String | 
$permission = ; // array[Permission] | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $accountId = accountId_example; # String | 
my $labelId = labelId_example; # String | 
my $permission = [WWW::OPenAPIClient::Object::array[Permission]->new()]; # array[Permission] | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
accountId = accountId_example # String |  (default to null)
labelId = labelId_example # String |  (default to null)
permission =  # array[Permission] | 

try: 
    # updates permissions of the personalaccount and label when the permissions list is empty the permissions are removed
    api_response = api_instance.update_local_permissions_for_label(accountId, labelId, permission)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->updateLocalPermissionsForLabel: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let accountId = accountId_example; // String
    let labelId = labelId_example; // String
    let permission = ; // array[Permission]

    let mut context = PersonalAccountApi::Context::default();
    let result = client.updateLocalPermissionsForLabel(accountId, labelId, permission, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Required
labelId*
String
Required
Body parameters
Name Description
permission *

[ (0..256)

local permission

undefined
]

Responses

Status: 200 - local permissions

{
Required: labelId,permissions
labelId:
undefined
permissions:
[ (0..20)
undefined
]

Status: 204 - local permissions removed


updatePersonalAccountRolesById

update personal account roles by id


/personalaccount/{accountId}/role

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/personalaccount/{accountId}/role"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PersonalAccountApi;

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

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        array[String] string = ; // array[String] | 
        try {
            PersonalAccount result = apiInstance.updatePersonalAccountRolesById(accountId, string);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#updatePersonalAccountRolesById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PersonalAccountApi;

public class PersonalAccountApiExample {

    public static void main(String[] args) {
        PersonalAccountApi apiInstance = new PersonalAccountApi();
        String accountId = accountId_example; // String | 
        array[String] string = ; // array[String] | 
        try {
            PersonalAccount result = apiInstance.updatePersonalAccountRolesById(accountId, string);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalAccountApi#updatePersonalAccountRolesById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountId = accountId_example; //  (default to null)
array[String] *string = ; // 

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

// update personal account roles by id
[apiInstance updatePersonalAccountRolesByIdWith:accountId
    string:string
              completionHandler: ^(PersonalAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.PersonalAccountApi()
var accountId = accountId_example; // {String} 
var string = ; // {array[String]} 

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

namespace Example
{
    public class updatePersonalAccountRolesByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PersonalAccountApi();
            var accountId = accountId_example;  // String |  (default to null)
            var string = new array[String](); // array[String] | 

            try
            {
                // update personal account roles by id
                PersonalAccount result = apiInstance.updatePersonalAccountRolesById(accountId, string);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalAccountApi.updatePersonalAccountRolesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\PersonalAccountApi();
$accountId = accountId_example; // String | 
$string = ; // array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::PersonalAccountApi->new();
my $accountId = accountId_example; # String | 
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.PersonalAccountApi()
accountId = accountId_example # String |  (default to null)
string =  # array[String] | 

try: 
    # update personal account roles by id
    api_response = api_instance.update_personal_account_roles_by_id(accountId, string)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalAccountApi->updatePersonalAccountRolesById: %s\n" % e)
extern crate PersonalAccountApi;

pub fn main() {
    let accountId = accountId_example; // String
    let string = ; // array[String]

    let mut context = PersonalAccountApi::Context::default();
    let result = client.updatePersonalAccountRolesById(accountId, string, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
accountId*
String
Required
Body parameters
Name Description
string *

[ (0..20)

role names

undefined
]

Responses

Status: 200 - updated personal account

{
id:
undefined
name:
string maxLength:1024
roles:
[ (0..20)
undefined
]

Status: 500 - server error

{
Required: message
message:
string

Release

createRelease

releases a list of artifact sets these sets will be verified


/supplychain/{supplyChainId}/release

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/release"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReleaseApi;

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

public class ReleaseApiExample {

    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 HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ReleaseApi apiInstance = new ReleaseApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        ReleaseArtifacts releaseArtifacts = ; // ReleaseArtifacts | 
        try {
            ReleaseResult result = apiInstance.createRelease(supplyChainId, releaseArtifacts);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseApi#createRelease");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReleaseApi;

public class ReleaseApiExample {

    public static void main(String[] args) {
        ReleaseApi apiInstance = new ReleaseApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        ReleaseArtifacts releaseArtifacts = ; // ReleaseArtifacts | 
        try {
            ReleaseResult result = apiInstance.createRelease(supplyChainId, releaseArtifacts);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseApi#createRelease");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
ReleaseArtifacts *releaseArtifacts = ; // 

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

// releases a list of artifact sets these sets will be verified
[apiInstance createReleaseWith:supplyChainId
    releaseArtifacts:releaseArtifacts
              completionHandler: ^(ReleaseResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

var api = new ArgosService.ReleaseApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var releaseArtifacts = ; // {ReleaseArtifacts} 

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

namespace Example
{
    public class createReleaseExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ReleaseApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var releaseArtifacts = new ReleaseArtifacts(); // ReleaseArtifacts | 

            try
            {
                // releases a list of artifact sets these sets will be verified
                ReleaseResult result = apiInstance.createRelease(supplyChainId, releaseArtifacts);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReleaseApi.createRelease: " + 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 HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ReleaseApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$releaseArtifacts = ; // ReleaseArtifacts | 

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

# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ReleaseApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $releaseArtifacts = WWW::OPenAPIClient::Object::ReleaseArtifacts->new(); # ReleaseArtifacts | 

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

# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ReleaseApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
releaseArtifacts =  # ReleaseArtifacts | 

try: 
    # releases a list of artifact sets these sets will be verified
    api_response = api_instance.create_release(supplyChainId, releaseArtifacts)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReleaseApi->createRelease: %s\n" % e)
extern crate ReleaseApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let releaseArtifacts = ; // ReleaseArtifacts

    let mut context = ReleaseApi::Context::default();
    let result = client.createRelease(supplyChainId, releaseArtifacts, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
releaseArtifacts *

{
releaseArtifacts:
[ (1..256)
[ (1..4096)
undefined
]
]

Responses

Status: 200 - VerificationResult

{
releaseIsValid:
boolean
releaseDossierMetaData:
undefined

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

SearchAccount

searchAccounts

searches for service accounts and personal accounts


/supplychain/{supplyChainId}/account

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/account?name=&accountType="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchAccountApi;

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

public class SearchAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SearchAccountApi apiInstance = new SearchAccountApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        String name = name_example; // String | 
        AccountType accountType = ; // AccountType | 
        try {
            array[AccountInfo] result = apiInstance.searchAccounts(supplyChainId, name, accountType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchAccountApi#searchAccounts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SearchAccountApi;

public class SearchAccountApiExample {

    public static void main(String[] args) {
        SearchAccountApi apiInstance = new SearchAccountApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        String name = name_example; // String | 
        AccountType accountType = ; // AccountType | 
        try {
            array[AccountInfo] result = apiInstance.searchAccounts(supplyChainId, name, accountType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchAccountApi#searchAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
String *name = name_example; //  (default to null)
AccountType *accountType = ; //  (optional) (default to null)

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

// searches for service accounts and personal accounts
[apiInstance searchAccountsWith:supplyChainId
    name:name
    accountType:accountType
              completionHandler: ^(array[AccountInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SearchAccountApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var name = name_example; // {String} 
var opts = {
  'accountType':  // {AccountType} 
};

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

namespace Example
{
    public class searchAccountsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SearchAccountApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var name = name_example;  // String |  (default to null)
            var accountType = new AccountType(); // AccountType |  (optional)  (default to null)

            try
            {
                // searches for service accounts and personal accounts
                array[AccountInfo] result = apiInstance.searchAccounts(supplyChainId, name, accountType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchAccountApi.searchAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SearchAccountApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$name = name_example; // String | 
$accountType = ; // AccountType | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SearchAccountApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $name = name_example; # String | 
my $accountType = ; # AccountType | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SearchAccountApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
name = name_example # String |  (default to null)
accountType =  # AccountType |  (optional) (default to null)

try: 
    # searches for service accounts and personal accounts
    api_response = api_instance.search_accounts(supplyChainId, name, accountType=accountType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchAccountApi->searchAccounts: %s\n" % e)
extern crate SearchAccountApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let name = name_example; // String
    let accountType = ; // AccountType

    let mut context = SearchAccountApi::Context::default();
    let result = client.searchAccounts(supplyChainId, name, accountType, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Query parameters
Name Description
name*
String
Required
accountType
AccountType

Responses

Status: 200 - array of AccountInfo

[
{
accountId:
undefined
name:
string maxLength:1024
path:
string
accountType:
undefined
]

Status: 500 - server error

{
Required: message
message:
string

searchKeysFromAccount

searches on keys of service accounts and personal accounts


/supplychain/{supplyChainId}/account/key

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/account/key?keyIds="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SearchAccountApi;

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

public class SearchAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SearchAccountApi apiInstance = new SearchAccountApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        array[String] keyIds = ; // array[String] | 
        try {
            array[AccountKeyInfo] result = apiInstance.searchKeysFromAccount(supplyChainId, keyIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchAccountApi#searchKeysFromAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SearchAccountApi;

public class SearchAccountApiExample {

    public static void main(String[] args) {
        SearchAccountApi apiInstance = new SearchAccountApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        array[String] keyIds = ; // array[String] | 
        try {
            array[AccountKeyInfo] result = apiInstance.searchKeysFromAccount(supplyChainId, keyIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchAccountApi#searchKeysFromAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
array[String] *keyIds = ; //  (optional) (default to null)

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

// searches on keys of service accounts and personal accounts
[apiInstance searchKeysFromAccountWith:supplyChainId
    keyIds:keyIds
              completionHandler: ^(array[AccountKeyInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SearchAccountApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var opts = {
  'keyIds':  // {array[String]} 
};

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

namespace Example
{
    public class searchKeysFromAccountExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SearchAccountApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var keyIds = new array[String](); // array[String] |  (optional)  (default to null)

            try
            {
                // searches on keys of service accounts and personal accounts
                array[AccountKeyInfo] result = apiInstance.searchKeysFromAccount(supplyChainId, keyIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchAccountApi.searchKeysFromAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SearchAccountApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$keyIds = ; // array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SearchAccountApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $keyIds = []; # array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SearchAccountApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
keyIds =  # array[String] |  (optional) (default to null)

try: 
    # searches on keys of service accounts and personal accounts
    api_response = api_instance.search_keys_from_account(supplyChainId, keyIds=keyIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchAccountApi->searchKeysFromAccount: %s\n" % e)
extern crate SearchAccountApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let keyIds = ; // array[String]

    let mut context = SearchAccountApi::Context::default();
    let result = client.searchKeysFromAccount(supplyChainId, keyIds, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Query parameters
Name Description
keyIds
array[String]

Responses

Status: 200 - array of AccountKeyInfo

[
{
Required: keyId,keyStatus
accountId:
undefined
name:
string maxLength:1024
path:
string
accountType:
undefined
keyId:
undefined
keyStatus:
string
Enum: ACTIVE, INACTIVE, DELETED
]

Status: 500 - server error

{
Required: message
message:
string

ServiceAccount

createServiceAccount

create a new service account


/serviceaccount

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        ServiceAccount serviceAccount = ; // ServiceAccount | 
        try {
            ServiceAccount result = apiInstance.createServiceAccount(serviceAccount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#createServiceAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        ServiceAccount serviceAccount = ; // ServiceAccount | 
        try {
            ServiceAccount result = apiInstance.createServiceAccount(serviceAccount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#createServiceAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

ServiceAccount *serviceAccount = ; //  (optional)

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

// create a new service account
[apiInstance createServiceAccountWith:serviceAccount
              completionHandler: ^(ServiceAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.ServiceAccountApi()
var opts = {
  'serviceAccount':  // {ServiceAccount} 
};

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

namespace Example
{
    public class createServiceAccountExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();
            var serviceAccount = new ServiceAccount(); // ServiceAccount |  (optional) 

            try
            {
                // create a new service account
                ServiceAccount result = apiInstance.createServiceAccount(serviceAccount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.createServiceAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();
$serviceAccount = ; // ServiceAccount | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();
my $serviceAccount = WWW::OPenAPIClient::Object::ServiceAccount->new(); # ServiceAccount | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()
serviceAccount =  # ServiceAccount |  (optional)

try: 
    # create a new service account
    api_response = api_instance.create_service_account(serviceAccount=serviceAccount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->createServiceAccount: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {
    let serviceAccount = ; // ServiceAccount

    let mut context = ServiceAccountApi::Context::default();
    let result = client.createServiceAccount(serviceAccount, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
serviceAccount

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Responses

Status: 201 - created

Name Type Format Description
Location URI uri location where the created service account can be found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

createServiceAccountKeyById

create a new active key the old key will be made inactive


/serviceaccount/{serviceAccountId}/key

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount/{serviceAccountId}/key"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        ServiceAccountKeyPair serviceAccountKeyPair = ; // ServiceAccountKeyPair | 
        try {
            ServiceAccountKeyPair result = apiInstance.createServiceAccountKeyById(serviceAccountId, serviceAccountKeyPair);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#createServiceAccountKeyById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        ServiceAccountKeyPair serviceAccountKeyPair = ; // ServiceAccountKeyPair | 
        try {
            ServiceAccountKeyPair result = apiInstance.createServiceAccountKeyById(serviceAccountId, serviceAccountKeyPair);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#createServiceAccountKeyById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *serviceAccountId = serviceAccountId_example; //  (default to null)
ServiceAccountKeyPair *serviceAccountKeyPair = ; //  (optional)

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

// create a new active key the old key will be made inactive
[apiInstance createServiceAccountKeyByIdWith:serviceAccountId
    serviceAccountKeyPair:serviceAccountKeyPair
              completionHandler: ^(ServiceAccountKeyPair output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.ServiceAccountApi()
var serviceAccountId = serviceAccountId_example; // {String} 
var opts = {
  'serviceAccountKeyPair':  // {ServiceAccountKeyPair} 
};

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

namespace Example
{
    public class createServiceAccountKeyByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();
            var serviceAccountId = serviceAccountId_example;  // String |  (default to null)
            var serviceAccountKeyPair = new ServiceAccountKeyPair(); // ServiceAccountKeyPair |  (optional) 

            try
            {
                // create a new active key the old key will be made inactive
                ServiceAccountKeyPair result = apiInstance.createServiceAccountKeyById(serviceAccountId, serviceAccountKeyPair);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.createServiceAccountKeyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();
$serviceAccountId = serviceAccountId_example; // String | 
$serviceAccountKeyPair = ; // ServiceAccountKeyPair | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();
my $serviceAccountId = serviceAccountId_example; # String | 
my $serviceAccountKeyPair = WWW::OPenAPIClient::Object::ServiceAccountKeyPair->new(); # ServiceAccountKeyPair | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()
serviceAccountId = serviceAccountId_example # String |  (default to null)
serviceAccountKeyPair =  # ServiceAccountKeyPair |  (optional)

try: 
    # create a new active key the old key will be made inactive
    api_response = api_instance.create_service_account_key_by_id(serviceAccountId, serviceAccountKeyPair=serviceAccountKeyPair)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->createServiceAccountKeyById: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {
    let serviceAccountId = serviceAccountId_example; // String
    let serviceAccountKeyPair = ; // ServiceAccountKeyPair

    let mut context = ServiceAccountApi::Context::default();
    let result = client.createServiceAccountKeyById(serviceAccountId, serviceAccountKeyPair, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
serviceAccountId*
String
Required
Body parameters
Name Description
serviceAccountKeyPair

{
Required: encryptedPrivateKey,hashedKeyPassphrase,keyId,publicKey
keyId:
undefined
publicKey:
undefined
encryptedPrivateKey:
undefined
hashedKeyPassphrase:
undefined

Responses

Status: 201 - created

Name Type Format Description
Location URI uri location where the created key can be found

Status: 404 - the service account is not found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

deleteServiceAccount

deletes a service account


/serviceaccount/{serviceAccountId}

Usage and SDK Samples

curl -X DELETE -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount/{serviceAccountId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        try {
            apiInstance.deleteServiceAccount(serviceAccountId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#deleteServiceAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        try {
            apiInstance.deleteServiceAccount(serviceAccountId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#deleteServiceAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *serviceAccountId = serviceAccountId_example; //  (default to null)

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

// deletes a service account
[apiInstance deleteServiceAccountWith:serviceAccountId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.ServiceAccountApi()
var serviceAccountId = serviceAccountId_example; // {String} 

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

namespace Example
{
    public class deleteServiceAccountExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();
            var serviceAccountId = serviceAccountId_example;  // String |  (default to null)

            try
            {
                // deletes a service account
                apiInstance.deleteServiceAccount(serviceAccountId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.deleteServiceAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();
$serviceAccountId = serviceAccountId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();
my $serviceAccountId = serviceAccountId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()
serviceAccountId = serviceAccountId_example # String |  (default to null)

try: 
    # deletes a service account
    api_instance.delete_service_account(serviceAccountId)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->deleteServiceAccount: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {
    let serviceAccountId = serviceAccountId_example; // String

    let mut context = ServiceAccountApi::Context::default();
    let result = client.deleteServiceAccount(serviceAccountId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
serviceAccountId*
String
Required

Responses

Status: 204 - deleted service account

Status: 404 - the service account is not found

Status: 500 - server error

{
Required: message
message:
string

getServiceAccountById

find service account by id


/serviceaccount/{serviceAccountId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount/{serviceAccountId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        try {
            ServiceAccount result = apiInstance.getServiceAccountById(serviceAccountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#getServiceAccountById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        try {
            ServiceAccount result = apiInstance.getServiceAccountById(serviceAccountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#getServiceAccountById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *serviceAccountId = serviceAccountId_example; //  (default to null)

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

// find service account by id
[apiInstance getServiceAccountByIdWith:serviceAccountId
              completionHandler: ^(ServiceAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.ServiceAccountApi()
var serviceAccountId = serviceAccountId_example; // {String} 

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

namespace Example
{
    public class getServiceAccountByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();
            var serviceAccountId = serviceAccountId_example;  // String |  (default to null)

            try
            {
                // find service account by id
                ServiceAccount result = apiInstance.getServiceAccountById(serviceAccountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.getServiceAccountById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();
$serviceAccountId = serviceAccountId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();
my $serviceAccountId = serviceAccountId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()
serviceAccountId = serviceAccountId_example # String |  (default to null)

try: 
    # find service account by id
    api_response = api_instance.get_service_account_by_id(serviceAccountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->getServiceAccountById: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {
    let serviceAccountId = serviceAccountId_example; // String

    let mut context = ServiceAccountApi::Context::default();
    let result = client.getServiceAccountById(serviceAccountId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
serviceAccountId*
String
Required

Responses

Status: 200 - service account

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 404 - the service account is not found

Status: 500 - server error

{
Required: message
message:
string

getServiceAccountKey

return the active key pair


/serviceaccount/me/activekey

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount/me/activekey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    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");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        try {
            ServiceAccountKeyPair result = apiInstance.getServiceAccountKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#getServiceAccountKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        try {
            ServiceAccountKeyPair result = apiInstance.getServiceAccountKey();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#getServiceAccountKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


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

// return the active key pair
[apiInstance getServiceAccountKeyWithCompletionHandler: 
              ^(ServiceAccountKeyPair output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

namespace Example
{
    public class getServiceAccountKeyExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();

            try
            {
                // return the active key pair
                ServiceAccountKeyPair result = apiInstance.getServiceAccountKey();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.getServiceAccountKey: " + 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');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();

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

# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();

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

# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()

try: 
    # return the active key pair
    api_response = api_instance.get_service_account_key()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->getServiceAccountKey: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {

    let mut context = ServiceAccountApi::Context::default();
    let result = client.getServiceAccountKey(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses

Status: 200 - active key

{
Required: encryptedPrivateKey,hashedKeyPassphrase,keyId,publicKey
keyId:
undefined
publicKey:
undefined
encryptedPrivateKey:
undefined
hashedKeyPassphrase:
undefined

Status: 404 - no active key exists

Status: 500 - server error

{
Required: message
message:
string

getServiceAccountKeyById

return the active key pair


/serviceaccount/{serviceAccountId}/key

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount/{serviceAccountId}/key"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        try {
            ServiceAccountKeyPair result = apiInstance.getServiceAccountKeyById(serviceAccountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#getServiceAccountKeyById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        try {
            ServiceAccountKeyPair result = apiInstance.getServiceAccountKeyById(serviceAccountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#getServiceAccountKeyById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *serviceAccountId = serviceAccountId_example; //  (default to null)

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

// return the active key pair
[apiInstance getServiceAccountKeyByIdWith:serviceAccountId
              completionHandler: ^(ServiceAccountKeyPair output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.ServiceAccountApi()
var serviceAccountId = serviceAccountId_example; // {String} 

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

namespace Example
{
    public class getServiceAccountKeyByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();
            var serviceAccountId = serviceAccountId_example;  // String |  (default to null)

            try
            {
                // return the active key pair
                ServiceAccountKeyPair result = apiInstance.getServiceAccountKeyById(serviceAccountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.getServiceAccountKeyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();
$serviceAccountId = serviceAccountId_example; // String | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();
my $serviceAccountId = serviceAccountId_example; # String | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()
serviceAccountId = serviceAccountId_example # String |  (default to null)

try: 
    # return the active key pair
    api_response = api_instance.get_service_account_key_by_id(serviceAccountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->getServiceAccountKeyById: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {
    let serviceAccountId = serviceAccountId_example; // String

    let mut context = ServiceAccountApi::Context::default();
    let result = client.getServiceAccountKeyById(serviceAccountId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
serviceAccountId*
String
Required

Responses

Status: 200 - created

{
Required: encryptedPrivateKey,hashedKeyPassphrase,keyId,publicKey
keyId:
undefined
publicKey:
undefined
encryptedPrivateKey:
undefined
hashedKeyPassphrase:
undefined

Status: 404 - no active key exists

Status: 500 - server error

{
Required: message
message:
string

updateServiceAccountById

update service account by id


/serviceaccount/{serviceAccountId}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/serviceaccount/{serviceAccountId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceAccountApi;

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

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        ServiceAccount serviceAccount = ; // ServiceAccount | 
        try {
            ServiceAccount result = apiInstance.updateServiceAccountById(serviceAccountId, serviceAccount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#updateServiceAccountById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceAccountApi;

public class ServiceAccountApiExample {

    public static void main(String[] args) {
        ServiceAccountApi apiInstance = new ServiceAccountApi();
        String serviceAccountId = serviceAccountId_example; // String | 
        ServiceAccount serviceAccount = ; // ServiceAccount | 
        try {
            ServiceAccount result = apiInstance.updateServiceAccountById(serviceAccountId, serviceAccount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceAccountApi#updateServiceAccountById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *serviceAccountId = serviceAccountId_example; //  (default to null)
ServiceAccount *serviceAccount = ; //  (optional)

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

// update service account by id
[apiInstance updateServiceAccountByIdWith:serviceAccountId
    serviceAccount:serviceAccount
              completionHandler: ^(ServiceAccount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.ServiceAccountApi()
var serviceAccountId = serviceAccountId_example; // {String} 
var opts = {
  'serviceAccount':  // {ServiceAccount} 
};

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

namespace Example
{
    public class updateServiceAccountByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new ServiceAccountApi();
            var serviceAccountId = serviceAccountId_example;  // String |  (default to null)
            var serviceAccount = new ServiceAccount(); // ServiceAccount |  (optional) 

            try
            {
                // update service account by id
                ServiceAccount result = apiInstance.updateServiceAccountById(serviceAccountId, serviceAccount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServiceAccountApi.updateServiceAccountById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\ServiceAccountApi();
$serviceAccountId = serviceAccountId_example; // String | 
$serviceAccount = ; // ServiceAccount | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::ServiceAccountApi->new();
my $serviceAccountId = serviceAccountId_example; # String | 
my $serviceAccount = WWW::OPenAPIClient::Object::ServiceAccount->new(); # ServiceAccount | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.ServiceAccountApi()
serviceAccountId = serviceAccountId_example # String |  (default to null)
serviceAccount =  # ServiceAccount |  (optional)

try: 
    # update service account by id
    api_response = api_instance.update_service_account_by_id(serviceAccountId, serviceAccount=serviceAccount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceAccountApi->updateServiceAccountById: %s\n" % e)
extern crate ServiceAccountApi;

pub fn main() {
    let serviceAccountId = serviceAccountId_example; // String
    let serviceAccount = ; // ServiceAccount

    let mut context = ServiceAccountApi::Context::default();
    let result = client.updateServiceAccountById(serviceAccountId, serviceAccount, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
serviceAccountId*
String
Required
Body parameters
Name Description
serviceAccount

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Responses

Status: 200 - updated service account

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 404 - the service account is not found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

Supplychain

createSupplyChain

create a supplychain


/supplychain

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupplychainApi;

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

public class SupplychainApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SupplychainApi apiInstance = new SupplychainApi();
        SupplyChain supplyChain = ; // SupplyChain | 
        try {
            SupplyChain result = apiInstance.createSupplyChain(supplyChain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#createSupplyChain");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupplychainApi;

public class SupplychainApiExample {

    public static void main(String[] args) {
        SupplychainApi apiInstance = new SupplychainApi();
        SupplyChain supplyChain = ; // SupplyChain | 
        try {
            SupplyChain result = apiInstance.createSupplyChain(supplyChain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#createSupplyChain");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

SupplyChain *supplyChain = ; //  (optional)

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

// create a supplychain
[apiInstance createSupplyChainWith:supplyChain
              completionHandler: ^(SupplyChain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SupplychainApi()
var opts = {
  'supplyChain':  // {SupplyChain} 
};

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

namespace Example
{
    public class createSupplyChainExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SupplychainApi();
            var supplyChain = new SupplyChain(); // SupplyChain |  (optional) 

            try
            {
                // create a supplychain
                SupplyChain result = apiInstance.createSupplyChain(supplyChain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SupplychainApi.createSupplyChain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SupplychainApi();
$supplyChain = ; // SupplyChain | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SupplychainApi->new();
my $supplyChain = WWW::OPenAPIClient::Object::SupplyChain->new(); # SupplyChain | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SupplychainApi()
supplyChain =  # SupplyChain |  (optional)

try: 
    # create a supplychain
    api_response = api_instance.create_supply_chain(supplyChain=supplyChain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupplychainApi->createSupplyChain: %s\n" % e)
extern crate SupplychainApi;

pub fn main() {
    let supplyChain = ; // SupplyChain

    let mut context = SupplychainApi::Context::default();
    let result = client.createSupplyChain(supplyChain, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
supplyChain

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Responses

Status: 201 - created

Name Type Format Description
Location URI uri location where the created supplychain can be found

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

deleteSupplyChainById

delete supply chain by id. The layout, approval configs and link objects are also deleted


/supplychain/{supplyChainId}

Usage and SDK Samples

curl -X DELETE -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupplychainApi;

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

public class SupplychainApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SupplychainApi apiInstance = new SupplychainApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            apiInstance.deleteSupplyChainById(supplyChainId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#deleteSupplyChainById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupplychainApi;

public class SupplychainApiExample {

    public static void main(String[] args) {
        SupplychainApi apiInstance = new SupplychainApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            apiInstance.deleteSupplyChainById(supplyChainId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#deleteSupplyChainById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)

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

// delete supply chain by id. The layout, approval configs and link objects are also deleted
[apiInstance deleteSupplyChainByIdWith:supplyChainId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SupplychainApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id

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

namespace Example
{
    public class deleteSupplyChainByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SupplychainApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)

            try
            {
                // delete supply chain by id. The layout, approval configs and link objects are also deleted
                apiInstance.deleteSupplyChainById(supplyChainId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SupplychainApi.deleteSupplyChainById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SupplychainApi();
$supplyChainId = supplyChainId_example; // String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SupplychainApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SupplychainApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)

try: 
    # delete supply chain by id. The layout, approval configs and link objects are also deleted
    api_instance.delete_supply_chain_by_id(supplyChainId)
except ApiException as e:
    print("Exception when calling SupplychainApi->deleteSupplyChainById: %s\n" % e)
extern crate SupplychainApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String

    let mut context = SupplychainApi::Context::default();
    let result = client.deleteSupplyChainById(supplyChainId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required

Responses

Status: 204 - supply chain deleted

Status: 500 - server error

{
Required: message
message:
string

getSupplyChain

get a supplychain


/supplychain/{supplyChainId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupplychainApi;

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

public class SupplychainApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SupplychainApi apiInstance = new SupplychainApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            SupplyChain result = apiInstance.getSupplyChain(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#getSupplyChain");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupplychainApi;

public class SupplychainApiExample {

    public static void main(String[] args) {
        SupplychainApi apiInstance = new SupplychainApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        try {
            SupplyChain result = apiInstance.getSupplyChain(supplyChainId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#getSupplyChain");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)

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

// get a supplychain
[apiInstance getSupplyChainWith:supplyChainId
              completionHandler: ^(SupplyChain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SupplychainApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id

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

namespace Example
{
    public class getSupplyChainExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SupplychainApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)

            try
            {
                // get a supplychain
                SupplyChain result = apiInstance.getSupplyChain(supplyChainId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SupplychainApi.getSupplyChain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SupplychainApi();
$supplyChainId = supplyChainId_example; // String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SupplychainApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SupplychainApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)

try: 
    # get a supplychain
    api_response = api_instance.get_supply_chain(supplyChainId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupplychainApi->getSupplyChain: %s\n" % e)
extern crate SupplychainApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String

    let mut context = SupplychainApi::Context::default();
    let result = client.getSupplyChain(supplyChainId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required

Responses

Status: 200 - the supply chain item

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 500 - server error

{
Required: message
message:
string

getSupplyChainByPath

get supply chain by path


/supplychain

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain?name=&path="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupplychainApi;

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

public class SupplychainApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SupplychainApi apiInstance = new SupplychainApi();
        String name = name_example; // String | 
        array[String] path = ; // array[String] | 
        try {
            SupplyChain result = apiInstance.getSupplyChainByPath(name, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#getSupplyChainByPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupplychainApi;

public class SupplychainApiExample {

    public static void main(String[] args) {
        SupplychainApi apiInstance = new SupplychainApi();
        String name = name_example; // String | 
        array[String] path = ; // array[String] | 
        try {
            SupplyChain result = apiInstance.getSupplyChainByPath(name, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#getSupplyChainByPath");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *name = name_example; //  (default to null)
array[String] *path = ; //  (default to null)

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

// get supply chain by path
[apiInstance getSupplyChainByPathWith:name
    path:path
              completionHandler: ^(SupplyChain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SupplychainApi()
var name = name_example; // {String} 
var path = ; // {array[String]} 

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

namespace Example
{
    public class getSupplyChainByPathExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SupplychainApi();
            var name = name_example;  // String |  (default to null)
            var path = new array[String](); // array[String] |  (default to null)

            try
            {
                // get supply chain by path
                SupplyChain result = apiInstance.getSupplyChainByPath(name, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SupplychainApi.getSupplyChainByPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SupplychainApi();
$name = name_example; // String | 
$path = ; // array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SupplychainApi->new();
my $name = name_example; # String | 
my $path = []; # array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SupplychainApi()
name = name_example # String |  (default to null)
path =  # array[String] |  (default to null)

try: 
    # get supply chain by path
    api_response = api_instance.get_supply_chain_by_path(name, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupplychainApi->getSupplyChainByPath: %s\n" % e)
extern crate SupplychainApi;

pub fn main() {
    let name = name_example; // String
    let path = ; // array[String]

    let mut context = SupplychainApi::Context::default();
    let result = client.getSupplyChainByPath(name, path, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
name*
String
Required
path*
array[String]
Required

Responses

Status: 200 - the supply chain

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 404 - not found

Status: 500 - server error

{
Required: message
message:
string

updateSupplyChain

update supplychain by id


/supplychain/{supplyChainId}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SupplychainApi;

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

public class SupplychainApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        SupplychainApi apiInstance = new SupplychainApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        SupplyChain supplyChain = ; // SupplyChain | 
        try {
            SupplyChain result = apiInstance.updateSupplyChain(supplyChainId, supplyChain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#updateSupplyChain");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SupplychainApi;

public class SupplychainApiExample {

    public static void main(String[] args) {
        SupplychainApi apiInstance = new SupplychainApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        SupplyChain supplyChain = ; // SupplyChain | 
        try {
            SupplyChain result = apiInstance.updateSupplyChain(supplyChainId, supplyChain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SupplychainApi#updateSupplyChain");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
SupplyChain *supplyChain = ; // 

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

// update supplychain by id
[apiInstance updateSupplyChainWith:supplyChainId
    supplyChain:supplyChain
              completionHandler: ^(SupplyChain output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.SupplychainApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var supplyChain = ; // {SupplyChain} 

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

namespace Example
{
    public class updateSupplyChainExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SupplychainApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var supplyChain = new SupplyChain(); // SupplyChain | 

            try
            {
                // update supplychain by id
                SupplyChain result = apiInstance.updateSupplyChain(supplyChainId, supplyChain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SupplychainApi.updateSupplyChain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\SupplychainApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$supplyChain = ; // SupplyChain | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::SupplychainApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $supplyChain = WWW::OPenAPIClient::Object::SupplyChain->new(); # SupplyChain | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.SupplychainApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
supplyChain =  # SupplyChain | 

try: 
    # update supplychain by id
    api_response = api_instance.update_supply_chain(supplyChainId, supplyChain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SupplychainApi->updateSupplyChain: %s\n" % e)
extern crate SupplychainApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let supplyChain = ; // SupplyChain

    let mut context = SupplychainApi::Context::default();
    let result = client.updateSupplyChain(supplyChainId, supplyChain, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
supplyChain *

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Responses

Status: 200 - updated supply chain

{
Required: name,parentLabelId
id:
undefined
name:
undefined
parentLabelId:
undefined

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

Verification

getVerification

checks verification on a release artifact set and possibly domains


/supplychain/verification

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/verification?artifactHashes=&paths="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VerificationApi;

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

public class VerificationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VerificationApi apiInstance = new VerificationApi();
        array[String] artifactHashes = ; // array[String] | 
        array[String] paths = ; // array[String] | 
        try {
            VerificationResult result = apiInstance.getVerification(artifactHashes, paths);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerificationApi#getVerification");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VerificationApi;

public class VerificationApiExample {

    public static void main(String[] args) {
        VerificationApi apiInstance = new VerificationApi();
        array[String] artifactHashes = ; // array[String] | 
        array[String] paths = ; // array[String] | 
        try {
            VerificationResult result = apiInstance.getVerification(artifactHashes, paths);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerificationApi#getVerification");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

array[String] *artifactHashes = ; //  (default to null)
array[String] *paths = ; //  (optional) (default to null)

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

// checks verification on a release artifact set and possibly domains
[apiInstance getVerificationWith:artifactHashes
    paths:paths
              completionHandler: ^(VerificationResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

var api = new ArgosService.VerificationApi()
var artifactHashes = ; // {array[String]} 
var opts = {
  'paths':  // {array[String]} 
};

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

namespace Example
{
    public class getVerificationExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new VerificationApi();
            var artifactHashes = new array[String](); // array[String] |  (default to null)
            var paths = new array[String](); // array[String] |  (optional)  (default to null)

            try
            {
                // checks verification on a release artifact set and possibly domains
                VerificationResult result = apiInstance.getVerification(artifactHashes, paths);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VerificationApi.getVerification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\VerificationApi();
$artifactHashes = ; // array[String] | 
$paths = ; // array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::VerificationApi->new();
my $artifactHashes = []; # array[String] | 
my $paths = []; # array[String] | 

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

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.VerificationApi()
artifactHashes =  # array[String] |  (default to null)
paths =  # array[String] |  (optional) (default to null)

try: 
    # checks verification on a release artifact set and possibly domains
    api_response = api_instance.get_verification(artifactHashes, paths=paths)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VerificationApi->getVerification: %s\n" % e)
extern crate VerificationApi;

pub fn main() {
    let artifactHashes = ; // array[String]
    let paths = ; // array[String]

    let mut context = VerificationApi::Context::default();
    let result = client.getVerification(artifactHashes, paths, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
artifactHashes*
array[String]
Required
paths
array[String]

Responses

Status: 200 - VerificationResult

{
Required: runIsValid
runIsValid:
boolean

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string

performVerification

creates a verification run


/supplychain/{supplyChainId}/verification

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://raw.githubusercontent.com/api/supplychain/{supplyChainId}/verification"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VerificationApi;

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

public class VerificationApiExample {

    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 HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VerificationApi apiInstance = new VerificationApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        VerifyCommand verifyCommand = ; // VerifyCommand | 
        try {
            VerificationResult result = apiInstance.performVerification(supplyChainId, verifyCommand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerificationApi#performVerification");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VerificationApi;

public class VerificationApiExample {

    public static void main(String[] args) {
        VerificationApi apiInstance = new VerificationApi();
        String supplyChainId = supplyChainId_example; // String | supply chain id
        VerifyCommand verifyCommand = ; // VerifyCommand | 
        try {
            VerificationResult result = apiInstance.performVerification(supplyChainId, verifyCommand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VerificationApi#performVerification");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *supplyChainId = supplyChainId_example; // supply chain id (default to null)
VerifyCommand *verifyCommand = ; // 

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

// creates a verification run
[apiInstance performVerificationWith:supplyChainId
    verifyCommand:verifyCommand
              completionHandler: ^(VerificationResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ArgosService = require('argos_service');
var defaultClient = ArgosService.ApiClient.instance;

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

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

var api = new ArgosService.VerificationApi()
var supplyChainId = supplyChainId_example; // {String} supply chain id
var verifyCommand = ; // {VerifyCommand} 

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

namespace Example
{
    public class performVerificationExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new VerificationApi();
            var supplyChainId = supplyChainId_example;  // String | supply chain id (default to null)
            var verifyCommand = new VerifyCommand(); // VerifyCommand | 

            try
            {
                // creates a verification run
                VerificationResult result = apiInstance.performVerification(supplyChainId, verifyCommand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VerificationApi.performVerification: " + 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 HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\VerificationApi();
$supplyChainId = supplyChainId_example; // String | supply chain id
$verifyCommand = ; // VerifyCommand | 

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

# Configure HTTP basic authorization: basicAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';
# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::VerificationApi->new();
my $supplyChainId = supplyChainId_example; # String | supply chain id
my $verifyCommand = WWW::OPenAPIClient::Object::VerifyCommand->new(); # VerifyCommand | 

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

# Configure HTTP basic authorization: basicAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'
# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.VerificationApi()
supplyChainId = supplyChainId_example # String | supply chain id (default to null)
verifyCommand =  # VerifyCommand | 

try: 
    # creates a verification run
    api_response = api_instance.perform_verification(supplyChainId, verifyCommand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VerificationApi->performVerification: %s\n" % e)
extern crate VerificationApi;

pub fn main() {
    let supplyChainId = supplyChainId_example; // String
    let verifyCommand = ; // VerifyCommand

    let mut context = VerificationApi::Context::default();
    let result = client.performVerification(supplyChainId, verifyCommand, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
supplyChainId*
String

supply chain id

Required
Body parameters
Name Description
verifyCommand *

{
Required: expectedProducts
expectedProducts:
[ (1..4096)
undefined
]

Responses

Status: 200 - VerificationResult

{
Required: runIsValid
runIsValid:
boolean

Status: 400 - validation error

{
Required: messages
messages:
[
undefined
]

Status: 500 - server error

{
Required: message
message:
string