PkmRestfulApi

Annotations

deleteAnnotation

Delete annotation with the given ID in the given project


/annotations/{dbName}/{artefactId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/annotations/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnnotationsApi;

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

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

        // Create an instance of the API class
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the annotation
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteAnnotation(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#deleteAnnotation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AnnotationsApi;

public class AnnotationsApiExample {
    public static void main(String[] args) {
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the annotation
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteAnnotation(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#deleteAnnotation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AnnotationsApi *apiInstance = [[AnnotationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // the ID of the annotation (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteAnnotationWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.AnnotationsApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} the ID of the annotation
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new AnnotationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | the ID of the annotation (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteAnnotation(dbName, artefactId, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling AnnotationsApi.deleteAnnotation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnnotationsApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | the ID of the annotation
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AnnotationsApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | the ID of the annotation
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteAnnotation(dbName => $dbName, artefactId => $artefactId, key => $key);
};
if ($@) {
    warn "Exception when calling AnnotationsApi->deleteAnnotation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AnnotationsApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | the ID of the annotation (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_annotation(dbName, artefactId, key)
except ApiException as e:
    print("Exception when calling AnnotationsApi->deleteAnnotation: %s\n" % e)
extern crate AnnotationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = AnnotationsApi::Context::default();
    let result = client.deleteAnnotation(dbName, artefactId, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
the ID of the annotation
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteAnnotations

Delete annotations concerning the given dbName


/annotations/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/annotations/{dbName}?path=path_example&access=access_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnnotationsApi;

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

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

        // Create an instance of the API class
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String path = path_example; // String | the url-coded path in the pkm the retrieved annotations are about
        String access = access_example; // String | json path allowing to retrieve the text to analyze in the retrieved data

        try {
            apiInstance.deleteAnnotations(dbName, key, path, access);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#deleteAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AnnotationsApi;

public class AnnotationsApiExample {
    public static void main(String[] args) {
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String path = path_example; // String | the url-coded path in the pkm the retrieved annotations are about
        String access = access_example; // String | json path allowing to retrieve the text to analyze in the retrieved data

        try {
            apiInstance.deleteAnnotations(dbName, key, path, access);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#deleteAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AnnotationsApi *apiInstance = [[AnnotationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *path = path_example; // the url-coded path in the pkm the retrieved annotations are about (optional) (default to null)
String *access = access_example; // json path allowing to retrieve the text to analyze in the retrieved data (optional) (default to null)

[apiInstance deleteAnnotationsWith:dbName
    key:key
    path:path
    access:access
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.AnnotationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'path': path_example, // {String} the url-coded path in the pkm the retrieved annotations are about
  'access': access_example // {String} json path allowing to retrieve the text to analyze in the retrieved data
};

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

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

            // Create an instance of the API class
            var apiInstance = new AnnotationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var path = path_example;  // String | the url-coded path in the pkm the retrieved annotations are about (optional)  (default to null)
            var access = access_example;  // String | json path allowing to retrieve the text to analyze in the retrieved data (optional)  (default to null)

            try {
                apiInstance.deleteAnnotations(dbName, key, path, access);
            } catch (Exception e) {
                Debug.Print("Exception when calling AnnotationsApi.deleteAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnnotationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$path = path_example; // String | the url-coded path in the pkm the retrieved annotations are about
$access = access_example; // String | json path allowing to retrieve the text to analyze in the retrieved data

try {
    $api_instance->deleteAnnotations($dbName, $key, $path, $access);
} catch (Exception $e) {
    echo 'Exception when calling AnnotationsApi->deleteAnnotations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AnnotationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AnnotationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $path = path_example; # String | the url-coded path in the pkm the retrieved annotations are about
my $access = access_example; # String | json path allowing to retrieve the text to analyze in the retrieved data

eval {
    $api_instance->deleteAnnotations(dbName => $dbName, key => $key, path => $path, access => $access);
};
if ($@) {
    warn "Exception when calling AnnotationsApi->deleteAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AnnotationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
path = path_example # String | the url-coded path in the pkm the retrieved annotations are about (optional) (default to null)
access = access_example # String | json path allowing to retrieve the text to analyze in the retrieved data (optional) (default to null)

try:
    api_instance.delete_annotations(dbName, key, path=path, access=access)
except ApiException as e:
    print("Exception when calling AnnotationsApi->deleteAnnotations: %s\n" % e)
extern crate AnnotationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let path = path_example; // String
    let access = access_example; // String

    let mut context = AnnotationsApi::Context::default();
    let result = client.deleteAnnotations(dbName, key, path, access, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
path
String
the url-coded path in the pkm the retrieved annotations are about
access
String
json path allowing to retrieve the text to analyze in the retrieved data

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getAnnotation

Get annotation with the given ID in the given project


/annotations/{dbName}/{artefactId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/annotations/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnnotationsApi;

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

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

        // Create an instance of the API class
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the annotation
        String key = key_example; // String | Access key to the PKM

        try {
            PkmAnnotations result = apiInstance.getAnnotation(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#getAnnotation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AnnotationsApi;

public class AnnotationsApiExample {
    public static void main(String[] args) {
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the annotation
        String key = key_example; // String | Access key to the PKM

        try {
            PkmAnnotations result = apiInstance.getAnnotation(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#getAnnotation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AnnotationsApi *apiInstance = [[AnnotationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // the ID of the annotation (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getAnnotationWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(PkmAnnotations output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.AnnotationsApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} the ID of the annotation
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new AnnotationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | the ID of the annotation (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmAnnotations result = apiInstance.getAnnotation(dbName, artefactId, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AnnotationsApi.getAnnotation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnnotationsApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | the ID of the annotation
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AnnotationsApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | the ID of the annotation
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.AnnotationsApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | the ID of the annotation (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_annotation(dbName, artefactId, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnotationsApi->getAnnotation: %s\n" % e)
extern crate AnnotationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = AnnotationsApi::Context::default();
    let result = client.getAnnotation(dbName, artefactId, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
the ID of the annotation
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getAnnotations

Get annotations in the given project


/annotations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/annotations/{dbName}?path=path_example&access=access_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnnotationsApi;

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

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

        // Create an instance of the API class
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String path = path_example; // String | the url-coded path in the pkm the retrieved annotations are about
        String access = access_example; // String | json path allowing to retrieve the text to analyze in the retrieved data
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmAnnotations] result = apiInstance.getAnnotations(dbName, key, path, access, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#getAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AnnotationsApi;

public class AnnotationsApiExample {
    public static void main(String[] args) {
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String path = path_example; // String | the url-coded path in the pkm the retrieved annotations are about
        String access = access_example; // String | json path allowing to retrieve the text to analyze in the retrieved data
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmAnnotations] result = apiInstance.getAnnotations(dbName, key, path, access, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#getAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AnnotationsApi *apiInstance = [[AnnotationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *path = path_example; // the url-coded path in the pkm the retrieved annotations are about (optional) (default to null)
String *access = access_example; // json path allowing to retrieve the text to analyze in the retrieved data (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getAnnotationsWith:dbName
    key:key
    path:path
    access:access
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmAnnotations] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.AnnotationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'path': path_example, // {String} the url-coded path in the pkm the retrieved annotations are about
  'access': access_example, // {String} json path allowing to retrieve the text to analyze in the retrieved data
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new AnnotationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var path = path_example;  // String | the url-coded path in the pkm the retrieved annotations are about (optional)  (default to null)
            var access = access_example;  // String | json path allowing to retrieve the text to analyze in the retrieved data (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmAnnotations] result = apiInstance.getAnnotations(dbName, key, path, access, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AnnotationsApi.getAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnnotationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$path = path_example; // String | the url-coded path in the pkm the retrieved annotations are about
$access = access_example; // String | json path allowing to retrieve the text to analyze in the retrieved data
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getAnnotations($dbName, $key, $path, $access, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnotationsApi->getAnnotations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AnnotationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AnnotationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $path = path_example; # String | the url-coded path in the pkm the retrieved annotations are about
my $access = access_example; # String | json path allowing to retrieve the text to analyze in the retrieved data
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getAnnotations(dbName => $dbName, key => $key, path => $path, access => $access, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnnotationsApi->getAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AnnotationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
path = path_example # String | the url-coded path in the pkm the retrieved annotations are about (optional) (default to null)
access = access_example # String | json path allowing to retrieve the text to analyze in the retrieved data (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_annotations(dbName, key, path=path, access=access, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnotationsApi->getAnnotations: %s\n" % e)
extern crate AnnotationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let path = path_example; // String
    let access = access_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = AnnotationsApi::Context::default();
    let result = client.getAnnotations(dbName, key, path, access, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
path
String
the url-coded path in the pkm the retrieved annotations are about
access
String
json path allowing to retrieve the text to analyze in the retrieved data
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postAnnotations

Insert annotations in the given project


/annotations/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/annotations/{dbName}" \
 -d '{
  "path" : "path",
  "access" : "access"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnnotationsApi;

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

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

        // Create an instance of the API class
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAnnotations] body = ; // array[PkmAnnotations] | 

        try {
            array['String'] result = apiInstance.postAnnotations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#postAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AnnotationsApi;

public class AnnotationsApiExample {
    public static void main(String[] args) {
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAnnotations] body = ; // array[PkmAnnotations] | 

        try {
            array['String'] result = apiInstance.postAnnotations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#postAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AnnotationsApi *apiInstance = [[AnnotationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmAnnotations] *body = ; // 

[apiInstance postAnnotationsWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.AnnotationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmAnnotations]} 

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

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

            // Create an instance of the API class
            var apiInstance = new AnnotationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmAnnotations](); // array[PkmAnnotations] | 

            try {
                array['String'] result = apiInstance.postAnnotations(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AnnotationsApi.postAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnnotationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmAnnotations] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AnnotationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmAnnotations]->new()]; # array[PkmAnnotations] | 

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

# Create an instance of the API class
api_instance = openapi_client.AnnotationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmAnnotations] | 

try:
    api_response = api_instance.post_annotations(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnotationsApi->postAnnotations: %s\n" % e)
extern crate AnnotationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmAnnotations]

    let mut context = AnnotationsApi::Context::default();
    let result = client.postAnnotations(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Annotations

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putAnnotations

Insert (if not yet present) or update (if already present) some annotations into the database


/annotations/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/annotations/{dbName}" \
 -d '{
  "path" : "path",
  "access" : "access"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnnotationsApi;

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

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

        // Create an instance of the API class
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAnnotations] body = ; // array[PkmAnnotations] | 

        try {
            array['String'] result = apiInstance.putAnnotations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#putAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AnnotationsApi;

public class AnnotationsApiExample {
    public static void main(String[] args) {
        AnnotationsApi apiInstance = new AnnotationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAnnotations] body = ; // array[PkmAnnotations] | 

        try {
            array['String'] result = apiInstance.putAnnotations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnnotationsApi#putAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AnnotationsApi *apiInstance = [[AnnotationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmAnnotations] *body = ; // 

[apiInstance putAnnotationsWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.AnnotationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmAnnotations]} 

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

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

            // Create an instance of the API class
            var apiInstance = new AnnotationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmAnnotations](); // array[PkmAnnotations] | 

            try {
                array['String'] result = apiInstance.putAnnotations(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AnnotationsApi.putAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnnotationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmAnnotations] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AnnotationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmAnnotations]->new()]; # array[PkmAnnotations] | 

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

# Create an instance of the API class
api_instance = openapi_client.AnnotationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmAnnotations] | 

try:
    api_response = api_instance.put_annotations(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnnotationsApi->putAnnotations: %s\n" % e)
extern crate AnnotationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmAnnotations]

    let mut context = AnnotationsApi::Context::default();
    let result = client.putAnnotations(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Annotations

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

CVE

deleteCVE

Delete a CVE document from the database


/cve/{dbName}/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/cve/{dbName}/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CVEApi;

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

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

        // Create an instance of the API class
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String id = id_example; // String | the ID of the CVE document
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCVE(dbName, id, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#deleteCVE");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CVEApi;

public class CVEApiExample {
    public static void main(String[] args) {
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String id = id_example; // String | the ID of the CVE document
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCVE(dbName, id, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#deleteCVE");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CVEApi *apiInstance = [[CVEApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *id = id_example; // the ID of the CVE document (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCVEWith:dbName
    id:id
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CVEApi()
var dbName = dbName_example; // {String} Database name
var id = id_example; // {String} the ID of the CVE document
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CVEApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var id = id_example;  // String | the ID of the CVE document (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCVE(dbName, id, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CVEApi.deleteCVE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CVEApi();
$dbName = dbName_example; // String | Database name
$id = id_example; // String | the ID of the CVE document
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CVEApi->new();
my $dbName = dbName_example; # String | Database name
my $id = id_example; # String | the ID of the CVE document
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CVEApi()
dbName = dbName_example # String | Database name (default to null)
id = id_example # String | the ID of the CVE document (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cve(dbName, id, key)
except ApiException as e:
    print("Exception when calling CVEApi->deleteCVE: %s\n" % e)
extern crate CVEApi;

pub fn main() {
    let dbName = dbName_example; // String
    let id = id_example; // String
    let key = key_example; // String

    let mut context = CVEApi::Context::default();
    let result = client.deleteCVE(dbName, id, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
id*
String
the ID of the CVE document
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCVEs

Delete all CVE documents from the database


/cve/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/cve/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CVEApi;

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

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

        // Create an instance of the API class
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCVEs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#deleteCVEs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CVEApi;

public class CVEApiExample {
    public static void main(String[] args) {
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCVEs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#deleteCVEs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CVEApi *apiInstance = [[CVEApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCVEsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CVEApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CVEApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CVEApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CVEApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CVEApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cves(dbName, key)
except ApiException as e:
    print("Exception when calling CVEApi->deleteCVEs: %s\n" % e)
extern crate CVEApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CVEApi::Context::default();
    let result = client.deleteCVEs(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCVEs

Get all CVE documents from the database


/cve/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/cve/{dbName}?id=id_example&state=state_example&assigner=assigner_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CVEApi;

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

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

        // Create an instance of the API class
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String id = id_example; // String | CVE document ID
        String state = state_example; // String | CVE state
        String assigner = assigner_example; // String | CVE assigner
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmCve] result = apiInstance.getCVEs(dbName, key, id, state, assigner, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#getCVEs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CVEApi;

public class CVEApiExample {
    public static void main(String[] args) {
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String id = id_example; // String | CVE document ID
        String state = state_example; // String | CVE state
        String assigner = assigner_example; // String | CVE assigner
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmCve] result = apiInstance.getCVEs(dbName, key, id, state, assigner, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#getCVEs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CVEApi *apiInstance = [[CVEApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *id = id_example; // CVE document ID (optional) (default to null)
String *state = state_example; // CVE state (optional) (default to null)
String *assigner = assigner_example; // CVE assigner (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getCVEsWith:dbName
    key:key
    id:id
    state:state
    assigner:assigner
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmCve] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CVEApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': id_example, // {String} CVE document ID
  'state': state_example, // {String} CVE state
  'assigner': assigner_example, // {String} CVE assigner
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CVEApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = id_example;  // String | CVE document ID (optional)  (default to null)
            var state = state_example;  // String | CVE state (optional)  (default to null)
            var assigner = assigner_example;  // String | CVE assigner (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmCve] result = apiInstance.getCVEs(dbName, key, id, state, assigner, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CVEApi.getCVEs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CVEApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = id_example; // String | CVE document ID
$state = state_example; // String | CVE state
$assigner = assigner_example; // String | CVE assigner
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getCVEs($dbName, $key, $id, $state, $assigner, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CVEApi->getCVEs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CVEApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CVEApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = id_example; # String | CVE document ID
my $state = state_example; # String | CVE state
my $assigner = assigner_example; # String | CVE assigner
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getCVEs(dbName => $dbName, key => $key, id => $id, state => $state, assigner => $assigner, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CVEApi->getCVEs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CVEApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = id_example # String | CVE document ID (optional) (default to null)
state = state_example # String | CVE state (optional) (default to null)
assigner = assigner_example # String | CVE assigner (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_cves(dbName, key, id=id, state=state, assigner=assigner, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CVEApi->getCVEs: %s\n" % e)
extern crate CVEApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = id_example; // String
    let state = state_example; // String
    let assigner = assigner_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CVEApi::Context::default();
    let result = client.getCVEs(dbName, key, id, state, assigner, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
String
CVE document ID
state
String
CVE state
assigner
String
CVE assigner
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postCVEs

Post one or more CVE documents into the database


/cve/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/cve/{dbName}" \
 -d '{
  "data_format" : "data_format",
  "data_version" : "data_version",
  "cna-container" : {
    "problemtypes" : {
      "descriptions" : [ [ "{}", "{}" ], [ "{}", "{}" ] ]
    },
    "references" : [ {
      "refsource" : "refsource",
      "name" : "name",
      "url" : "url"
    }, {
      "refsource" : "refsource",
      "name" : "name",
      "url" : "url"
    } ],
    "affected" : {
      "vendors" : [ {
        "vendor_name" : "vendor_name",
        "products" : [ {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        }, {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        } ]
      }, {
        "vendor_name" : "vendor_name",
        "products" : [ {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        }, {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        } ]
      } ]
    },
    "descriptions" : [ {
      "lang" : "lang",
      "value" : "value"
    }, {
      "lang" : "lang",
      "value" : "value"
    } ]
  },
  "data_type" : "data_type",
  "CVE_data_meta" : {
    "ASSIGNER" : "ASSIGNER",
    "STATE" : "STATE",
    "UPDATED" : "UPDATED",
    "ID" : "ID"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CVEApi;

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

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

        // Create an instance of the API class
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCve] body = ; // array[PkmCve] | 

        try {
            apiInstance.postCVEs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#postCVEs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CVEApi;

public class CVEApiExample {
    public static void main(String[] args) {
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCve] body = ; // array[PkmCve] | 

        try {
            apiInstance.postCVEs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#postCVEs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CVEApi *apiInstance = [[CVEApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCve] *body = ; //  (optional)

[apiInstance postCVEsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CVEApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'body':  // {array[PkmCve]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new CVEApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCve](); // array[PkmCve] |  (optional) 

            try {
                apiInstance.postCVEs(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CVEApi.postCVEs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CVEApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCve] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CVEApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCve]->new()]; # array[PkmCve] | 

eval {
    $api_instance->postCVEs(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CVEApi->postCVEs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CVEApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCve] |  (optional)

try:
    api_instance.post_cves(dbName, key, body=body)
except ApiException as e:
    print("Exception when calling CVEApi->postCVEs: %s\n" % e)
extern crate CVEApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCve]

    let mut context = CVEApi::Context::default();
    let result = client.postCVEs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body

CVE documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCVEs

Insert (if not yet present) or update (if already present) one or more CVE documents into the database


/cve/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/cve/{dbName}" \
 -d '{
  "data_format" : "data_format",
  "data_version" : "data_version",
  "cna-container" : {
    "problemtypes" : {
      "descriptions" : [ [ "{}", "{}" ], [ "{}", "{}" ] ]
    },
    "references" : [ {
      "refsource" : "refsource",
      "name" : "name",
      "url" : "url"
    }, {
      "refsource" : "refsource",
      "name" : "name",
      "url" : "url"
    } ],
    "affected" : {
      "vendors" : [ {
        "vendor_name" : "vendor_name",
        "products" : [ {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        }, {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        } ]
      }, {
        "vendor_name" : "vendor_name",
        "products" : [ {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        }, {
          "versions" : [ {
            "version_value" : "version_value"
          }, {
            "version_value" : "version_value"
          } ]
        } ]
      } ]
    },
    "descriptions" : [ {
      "lang" : "lang",
      "value" : "value"
    }, {
      "lang" : "lang",
      "value" : "value"
    } ]
  },
  "data_type" : "data_type",
  "CVE_data_meta" : {
    "ASSIGNER" : "ASSIGNER",
    "STATE" : "STATE",
    "UPDATED" : "UPDATED",
    "ID" : "ID"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CVEApi;

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

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

        // Create an instance of the API class
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCve] body = ; // array[PkmCve] | 

        try {
            apiInstance.putCVEs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#putCVEs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CVEApi;

public class CVEApiExample {
    public static void main(String[] args) {
        CVEApi apiInstance = new CVEApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCve] body = ; // array[PkmCve] | 

        try {
            apiInstance.putCVEs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CVEApi#putCVEs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CVEApi *apiInstance = [[CVEApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCve] *body = ; //  (optional)

[apiInstance putCVEsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CVEApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'body':  // {array[PkmCve]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new CVEApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCve](); // array[PkmCve] |  (optional) 

            try {
                apiInstance.putCVEs(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CVEApi.putCVEs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CVEApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCve] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CVEApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCve]->new()]; # array[PkmCve] | 

eval {
    $api_instance->putCVEs(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CVEApi->putCVEs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CVEApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCve] |  (optional)

try:
    api_instance.put_cves(dbName, key, body=body)
except ApiException as e:
    print("Exception when calling CVEApi->putCVEs: %s\n" % e)
extern crate CVEApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCve]

    let mut context = CVEApi::Context::default();
    let result = client.putCVEs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body

CVE documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Code

deleteCAnnotations

Delete all C annotations documents from the database


/code/c/annotations/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/annotations/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCAnnotationsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_c_annotations(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCAnnotations(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCAnnotationsBySourceCodeFilename

Delete the C annotations documents related to a C source code file from the database


/code/c/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/annotations/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCAnnotationsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteCAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteCAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_c_annotations_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCAnnotationsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCComments

Delete all C comments documents from the database


/code/c/comments/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/comments/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCCommentsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_c_comments(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCComments(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCCommentsBySourceCodeFilename

Delete the C comments documents related to a C source code file from the database


/code/c/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/comments/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCCommentsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteCCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteCCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_c_comments_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCCommentsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCPPAnnotations

Delete all C++ annotations documents from the database


/code/cpp/annotations/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/annotations/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCPPAnnotationsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cpp_annotations(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCPPAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCPPAnnotations(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCPPAnnotationsBySourceCodeFilename

Delete the C++ annotations documents related to a C++ source code file from the database


/code/cpp/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/annotations/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C++ Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCPPAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C++ Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C++ Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCPPAnnotationsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteCPPAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C++ Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C++ Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCPPAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteCPPAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C++ Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cpp_annotations_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCPPAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCPPAnnotationsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C++ Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCPPComments

Delete all C++ comments documents from the database


/code/cpp/comments/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/comments/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCPPCommentsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cpp_comments(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCPPComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCPPComments(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCPPCommentsBySourceCodeFilename

Delete the C++ comments documents related to a C++ source code file from the database


/code/cpp/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/comments/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C++ Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCPPCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C++ Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C++ Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCPPCommentsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteCPPCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C++ Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C++ Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCPPCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteCPPCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C++ Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cpp_comments_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCPPCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCPPCommentsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C++ Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCPPSourceCodes

Delete all C++ source code documents (Abstract Syntax Tree) from the database


/code/cpp/sourcecode/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/sourcecode/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCPPSourceCodesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cpp_source_codes(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCPPSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCPPSourceCodes(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCPPSourceCodesBySourceCodeFilename

Delete the C++ source code documents (Abstract Syntax Tree) related to a C++ source code file from the database


/code/cpp/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/sourcecode/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCPPSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCPPSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C++ Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCPPSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C++ Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C++ Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCPPSourceCodesBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteCPPSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C++ Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C++ Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCPPSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteCPPSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C++ Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_cpp_source_codes_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCPPSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCPPSourceCodesBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C++ Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCSourceCodes

Delete all C source code documents (Abstract Syntax Tree) from the database


/code/c/sourcecode/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/sourcecode/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCSourceCodesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_c_source_codes(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCSourceCodes(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCSourceCodesBySourceCodeFilename

Delete the C source code documents (Abstract Syntax Tree) related to a C source code file from the database


/code/c/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/sourcecode/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteCSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCSourceCodesBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteCSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteCSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_c_source_codes_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteCSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteCSourceCodesBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteJavaAnnotations

Delete all Java annotations documents from the database


/code/java/annotations/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/annotations/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteJavaAnnotationsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_java_annotations(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteJavaAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteJavaAnnotations(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteJavaAnnotationsBySourceCodeFilename

Delete the Java annotations documents related to a Java source code file from the database


/code/java/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/annotations/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Java Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteJavaAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Java Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Java Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteJavaAnnotationsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteJavaAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Java Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Java Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteJavaAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteJavaAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Java Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_java_annotations_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteJavaAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteJavaAnnotationsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Java Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteJavaComments

Delete all Java comments documents from the database


/code/java/comments/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/comments/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteJavaCommentsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_java_comments(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteJavaComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteJavaComments(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteJavaCommentsBySourceCodeFilename

Delete the Java comments documents related to a Java source code file from the database


/code/java/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/comments/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Java Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteJavaCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Java Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Java Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteJavaCommentsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteJavaCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Java Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Java Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteJavaCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteJavaCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Java Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_java_comments_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteJavaCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteJavaCommentsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Java Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteJavaSourceCodes

Delete all Java source code documents (Abstract Syntax Tree) from the database


/code/java/sourcecode/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/sourcecode/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteJavaSourceCodesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_java_source_codes(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteJavaSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteJavaSourceCodes(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteJavaSourceCodesBySourceCodeFilename

Delete the Java source code documents (Abstract Syntax Tree) related to a Java source code file from the database


/code/java/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/sourcecode/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteJavaSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteJavaSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Java Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteJavaSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Java Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Java Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteJavaSourceCodesBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteJavaSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Java Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Java Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteJavaSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteJavaSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Java Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_java_source_codes_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteJavaSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteJavaSourceCodesBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Java Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteRawSourceCode

delete a source code file from the database


/code/rawsourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/rawsourcecode/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawSourceCode(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteRawSourceCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawSourceCode(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteRawSourceCode");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteRawSourceCodeWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteRawSourceCode(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteRawSourceCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteRawSourceCode(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteRawSourceCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_raw_source_code(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteRawSourceCode: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteRawSourceCode(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteRawSourceCodes

Delete all source code files present in the database together with source code ASTs, annotations and comments documents which originate from these source code files


/code/rawsourcecode/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/rawsourcecode/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteRawSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteRawSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteRawSourceCodesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_raw_source_codes(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteRawSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteRawSourceCodes(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteSourceCodeAnnotations

Delete all source code annotations documents from the database


/code/annotations/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/annotations/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeAnnotations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteSourceCodeAnnotationsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_source_code_annotations(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteSourceCodeAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteSourceCodeAnnotations(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteSourceCodeAnnotationsBySourceCodeFilename

Delete the source code annotations documents related to a source code file from the database


/code/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/annotations/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteSourceCodeAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteSourceCodeAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteSourceCodeAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteSourceCodeAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_source_code_annotations_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteSourceCodeAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteSourceCodeComments

Delete all source code comments documents from the database


/code/comments/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/comments/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeComments(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteSourceCodeCommentsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_source_code_comments(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteSourceCodeComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteSourceCodeComments(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteSourceCodeCommentsBySourceCodeFilename

Delete the source code comments documents related to a source code file from the database


/code/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/comments/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodeCommentsBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodeCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteSourceCodeCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteSourceCodeCommentsBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteSourceCodeCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteSourceCodeCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteSourceCodeCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_source_code_comments_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteSourceCodeCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteSourceCodeCommentsBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteSourceCodes

Delete all source code documents (Abstract Syntax Tree) from the database


/code/sourcecode/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/sourcecode/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodes(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteSourceCodesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_source_codes(dbName, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteSourceCodes(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteSourceCodesBySourceCodeFilename

Delete the source code documents (Abstract Syntax Tree) related to a source code file from the database


/code/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/sourcecode/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteSourceCodesBySourceCodeFilename(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#deleteSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteSourceCodesBySourceCodeFilename(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.deleteSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CodeApi->deleteSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_source_codes_by_source_code_filename(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CodeApi->deleteSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.deleteSourceCodesBySourceCodeFilename(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCAnnotations

Get all C annotations documents from the database


/code/c/annotations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/annotations/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[Object] result = apiInstance.getCAnnotations(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[Object] result = apiInstance.getCAnnotations(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCAnnotationsWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[Object] result = apiInstance.getCAnnotations(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCAnnotations($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCAnnotations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCAnnotations(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_c_annotations(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCAnnotations(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCAnnotationsBySourceCodeFilename

Get the C annotations documents related to a C source code file from the database


/code/c/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/annotations/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[Object] result = apiInstance.getCAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[Object] result = apiInstance.getCAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[Object] result = apiInstance.getCAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCAnnotationsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCAnnotationsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_c_annotations_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCComments

Get all C comments documents from the database


/code/c/comments/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/comments/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCComments] result = apiInstance.getCComments(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCComments] result = apiInstance.getCComments(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCCommentsWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCComments] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCComments] result = apiInstance.getCComments(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCComments($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCComments(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_c_comments(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCComments(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCCommentsBySourceCodeFilename

Get the C comments documents related to a C source code file from the database


/code/c/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/comments/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCComments] result = apiInstance.getCCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCComments] result = apiInstance.getCCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCComments] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCComments] result = apiInstance.getCCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCCommentsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCCommentsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_c_comments_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCFunctions

Get all C functions


/code/c/functions/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/functions/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCFunctions(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCFunctions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCFunctions(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCFunctions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCFunctionsWith:dbName
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCFunctions(dbName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCFunctions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_c_functions(dbName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCFunctions: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCFunctions(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCFunctionsByName

Get C functions by name


/code/c/functions/{dbName}/{funcname}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/functions/{dbName}/{funcname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String funcname = funcname_example; // String | Function name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCFunctionsByName(dbName, funcname, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCFunctionsByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String funcname = funcname_example; // String | Function name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCFunctionsByName(dbName, funcname, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCFunctionsByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *funcname = funcname_example; // Function name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCFunctionsByNameWith:dbName
    funcname:funcname
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var funcname = funcname_example; // {String} Function name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var funcname = funcname_example;  // String | Function name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCFunctionsByName(dbName, funcname, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCFunctionsByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$funcname = funcname_example; // String | Function name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $funcname = funcname_example; # String | Function name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
funcname = funcname_example # String | Function name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_c_functions_by_name(dbName, funcname, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCFunctionsByName: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let funcname = funcname_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCFunctionsByName(dbName, funcname, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
funcname*
String
Function name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPAnnotationArtefacts

Get a C++ annotation artefacts


/code/cpp/artefacts/annotations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/artefacts/annotations/{dbName}?id=1234&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            Object result = apiInstance.getCPPAnnotationArtefacts(dbName, key, id, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPAnnotationArtefacts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            Object result = apiInstance.getCPPAnnotationArtefacts(dbName, key, id, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPAnnotationArtefacts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *id = 1234; // artefact identifier (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getCPPAnnotationArtefactsWith:dbName
    key:key
    id:id
    skip:skip
    limit:limit
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': 1234, // {Integer} artefact identifier
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = 1234;  // Integer | artefact identifier (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                Object result = apiInstance.getCPPAnnotationArtefacts(dbName, key, id, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPAnnotationArtefacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = 1234; // Integer | artefact identifier
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = 1234; # Integer | artefact identifier
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = 1234 # Integer | artefact identifier (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_cpp_annotation_artefacts(dbName, key, id=id, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPAnnotationArtefacts: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = 1234; // Integer
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getCPPAnnotationArtefacts(dbName, key, id, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
Integer
artefact identifier
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPAnnotations

Get all C++ annotations documents from the database


/code/cpp/annotations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/annotations/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppAnnotations] result = apiInstance.getCPPAnnotations(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppAnnotations] result = apiInstance.getCPPAnnotations(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCPPAnnotationsWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCppAnnotations] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCppAnnotations] result = apiInstance.getCPPAnnotations(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCPPAnnotations($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPAnnotations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCPPAnnotations(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_cpp_annotations(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCPPAnnotations(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPAnnotationsBySourceCodeFilename

Get the C++ annotations documents related to a C++ source code file from the database


/code/cpp/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/annotations/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppAnnotations] result = apiInstance.getCPPAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppAnnotations] result = apiInstance.getCPPAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCPPAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCppAnnotations] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCppAnnotations] result = apiInstance.getCPPAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCPPAnnotationsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPAnnotationsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCPPAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_cpp_annotations_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCPPAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPClassFields

Get fields from a C++ class


/code/cpp/class/fields/{dbName}/{className}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/class/fields/{dbName}/{className}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCPPClassFields(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPClassFields");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCPPClassFields(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPClassFields");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *className = className_example; // class name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCPPClassFieldsWith:dbName
    className:className
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var className = className_example; // {String} class name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var className = className_example;  // String | class name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCPPClassFields(dbName, className, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPClassFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$className = className_example; // String | class name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $className = className_example; # String | class name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
className = className_example # String | class name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_cpp_class_fields(dbName, className, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPClassFields: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let className = className_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCPPClassFields(dbName, className, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
className*
String
class name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPClassMethods

Get methods from a C++ class


/code/cpp/class/methods/{dbName}/{className}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/class/methods/{dbName}/{className}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCPPClassMethods(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPClassMethods");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCPPClassMethods(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPClassMethods");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *className = className_example; // class name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCPPClassMethodsWith:dbName
    className:className
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var className = className_example; // {String} class name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var className = className_example;  // String | class name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCPPClassMethods(dbName, className, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPClassMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$className = className_example; // String | class name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $className = className_example; # String | class name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
className = className_example # String | class name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_cpp_class_methods(dbName, className, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPClassMethods: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let className = className_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCPPClassMethods(dbName, className, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
className*
String
class name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPCommentArtefacts

Get a C++ comment artefacts


/code/cpp/artefacts/comments/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/artefacts/comments/{dbName}?id=1234&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            Object result = apiInstance.getCPPCommentArtefacts(dbName, key, id, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPCommentArtefacts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            Object result = apiInstance.getCPPCommentArtefacts(dbName, key, id, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPCommentArtefacts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *id = 1234; // artefact identifier (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getCPPCommentArtefactsWith:dbName
    key:key
    id:id
    skip:skip
    limit:limit
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': 1234, // {Integer} artefact identifier
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = 1234;  // Integer | artefact identifier (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                Object result = apiInstance.getCPPCommentArtefacts(dbName, key, id, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPCommentArtefacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = 1234; // Integer | artefact identifier
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = 1234; # Integer | artefact identifier
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = 1234 # Integer | artefact identifier (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_cpp_comment_artefacts(dbName, key, id=id, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPCommentArtefacts: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = 1234; // Integer
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getCPPCommentArtefacts(dbName, key, id, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
Integer
artefact identifier
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPComments

Get all C++ comments documents from the database


/code/cpp/comments/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/comments/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppComments] result = apiInstance.getCPPComments(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppComments] result = apiInstance.getCPPComments(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCPPCommentsWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCppComments] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCppComments] result = apiInstance.getCPPComments(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCPPComments($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCPPComments(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_cpp_comments(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCPPComments(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPCommentsBySourceCodeFilename

Get the C++ comments documents related to a C++ source code file from the database


/code/cpp/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/comments/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppComments] result = apiInstance.getCPPCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C++ Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppComments] result = apiInstance.getCPPCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C++ Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCPPCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCppComments] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C++ Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C++ Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCppComments] result = apiInstance.getCPPCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C++ Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCPPCommentsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPCommentsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C++ Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCPPCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C++ Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_cpp_comments_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCPPCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C++ Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPSourceCodeArtefacts

Get a C++ source code artefacts


/code/cpp/artefacts/sourcecode/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/artefacts/sourcecode/{dbName}?id=1234&kind=/^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/&path=/^std::log[fl]?$/&name=/log[fl]?/&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        String kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/; // String | kind of C++ artefacts as a bare character string or a /regular expression/
        String path = /^std::log[fl]?$/; // String | abstract path of C++ artefacts as a bare character string or a /regular expression/
        String name = /log[fl]?/; // String | name of C++ artefacts as a bare character string or a /regular expression/
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            Object result = apiInstance.getCPPSourceCodeArtefacts(dbName, key, id, kind, path, name, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPSourceCodeArtefacts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        String kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/; // String | kind of C++ artefacts as a bare character string or a /regular expression/
        String path = /^std::log[fl]?$/; // String | abstract path of C++ artefacts as a bare character string or a /regular expression/
        String name = /log[fl]?/; // String | name of C++ artefacts as a bare character string or a /regular expression/
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            Object result = apiInstance.getCPPSourceCodeArtefacts(dbName, key, id, kind, path, name, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPSourceCodeArtefacts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *id = 1234; // artefact identifier (optional) (default to null)
String *kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/; // kind of C++ artefacts as a bare character string or a /regular expression/ (optional) (default to null)
String *path = /^std::log[fl]?$/; // abstract path of C++ artefacts as a bare character string or a /regular expression/ (optional) (default to null)
String *name = /log[fl]?/; // name of C++ artefacts as a bare character string or a /regular expression/ (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getCPPSourceCodeArtefactsWith:dbName
    key:key
    id:id
    kind:kind
    path:path
    name:name
    skip:skip
    limit:limit
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': 1234, // {Integer} artefact identifier
  'kind': /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/, // {String} kind of C++ artefacts as a bare character string or a /regular expression/
  'path': /^std::log[fl]?$/, // {String} abstract path of C++ artefacts as a bare character string or a /regular expression/
  'name': /log[fl]?/, // {String} name of C++ artefacts as a bare character string or a /regular expression/
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = 1234;  // Integer | artefact identifier (optional)  (default to null)
            var kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/;  // String | kind of C++ artefacts as a bare character string or a /regular expression/ (optional)  (default to null)
            var path = /^std::log[fl]?$/;  // String | abstract path of C++ artefacts as a bare character string or a /regular expression/ (optional)  (default to null)
            var name = /log[fl]?/;  // String | name of C++ artefacts as a bare character string or a /regular expression/ (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                Object result = apiInstance.getCPPSourceCodeArtefacts(dbName, key, id, kind, path, name, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPSourceCodeArtefacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = 1234; // Integer | artefact identifier
$kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/; // String | kind of C++ artefacts as a bare character string or a /regular expression/
$path = /^std::log[fl]?$/; // String | abstract path of C++ artefacts as a bare character string or a /regular expression/
$name = /log[fl]?/; // String | name of C++ artefacts as a bare character string or a /regular expression/
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getCPPSourceCodeArtefacts($dbName, $key, $id, $kind, $path, $name, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPSourceCodeArtefacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = 1234; # Integer | artefact identifier
my $kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/; # String | kind of C++ artefacts as a bare character string or a /regular expression/
my $path = /^std::log[fl]?$/; # String | abstract path of C++ artefacts as a bare character string or a /regular expression/
my $name = /log[fl]?/; # String | name of C++ artefacts as a bare character string or a /regular expression/
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getCPPSourceCodeArtefacts(dbName => $dbName, key => $key, id => $id, kind => $kind, path => $path, name => $name, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPSourceCodeArtefacts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = 1234 # Integer | artefact identifier (optional) (default to null)
kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/ # String | kind of C++ artefacts as a bare character string or a /regular expression/ (optional) (default to null)
path = /^std::log[fl]?$/ # String | abstract path of C++ artefacts as a bare character string or a /regular expression/ (optional) (default to null)
name = /log[fl]?/ # String | name of C++ artefacts as a bare character string or a /regular expression/ (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_cpp_source_code_artefacts(dbName, key, id=id, kind=kind, path=path, name=name, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPSourceCodeArtefacts: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = 1234; // Integer
    let kind = /^function$|^variable$|^typedef$|^struct$|^union$|^class$|^field$|^method$/; // String
    let path = /^std::log[fl]?$/; // String
    let name = /log[fl]?/; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getCPPSourceCodeArtefacts(dbName, key, id, kind, path, name, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
Integer
artefact identifier
kind
String
kind of C++ artefacts as a bare character string or a /regular expression/
path
String
abstract path of C++ artefacts as a bare character string or a /regular expression/
name
String
name of C++ artefacts as a bare character string or a /regular expression/
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPSourceCodes

Get all C++ source code documents (Abstract Syntax Tree) from the database


/code/cpp/sourcecode/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/sourcecode/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppSourceCode] result = apiInstance.getCPPSourceCodes(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppSourceCode] result = apiInstance.getCPPSourceCodes(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCPPSourceCodesWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCppSourceCode] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCppSourceCode] result = apiInstance.getCPPSourceCodes(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCPPSourceCodes($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPSourceCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCPPSourceCodes(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_cpp_source_codes(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCPPSourceCodes(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCPPSourceCodesBySourceCodeFilename

Get the C++ source code documents (Abstract Syntax Tree) related to a C source code file from the database


/code/cpp/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/sourcecode/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppSourceCode] result = apiInstance.getCPPSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCppSourceCode] result = apiInstance.getCPPSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCPPSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCPPSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCppSourceCode] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCppSourceCode] result = apiInstance.getCPPSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCPPSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCPPSourceCodesBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCPPSourceCodesBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCPPSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCPPSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_cpp_source_codes_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCPPSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCPPSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCSourceCodes

Get all C source code documents (Abstract Syntax Tree) from the database


/code/c/sourcecode/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/sourcecode/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCSourceCode] result = apiInstance.getCSourceCodes(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCSourceCode] result = apiInstance.getCSourceCodes(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCSourceCodesWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCSourceCode] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCSourceCode] result = apiInstance.getCSourceCodes(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCSourceCodes($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCSourceCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCSourceCodes(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_c_source_codes(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCSourceCodes(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCSourceCodesBySourceCodeFilename

Get the C source code documents (Abstract Syntax Tree) related to a C source code file from the database


/code/c/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/sourcecode/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCSourceCode] result = apiInstance.getCSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | C Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmCSourceCode] result = apiInstance.getCSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // C Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getCSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmCSourceCode] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} C Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | C Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmCSourceCode] result = apiInstance.getCSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | C Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getCSourceCodesBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getCSourceCodesBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | C Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getCSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getCSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | C Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_c_source_codes_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getCSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
C Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCTypes

Get all C types


/code/c/types/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/types/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCTypes(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCTypes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCTypes(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCTypes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCTypesWith:dbName
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCTypes(dbName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_c_types(dbName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCTypes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCTypes(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCTypesByName

Get C types by name


/code/c/types/{dbName}/{typename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/types/{dbName}/{typename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String typename = typename_example; // String | Type name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCTypesByName(dbName, typename, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCTypesByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String typename = typename_example; // String | Type name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCTypesByName(dbName, typename, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCTypesByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *typename = typename_example; // Type name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCTypesByNameWith:dbName
    typename:typename
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var typename = typename_example; // {String} Type name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var typename = typename_example;  // String | Type name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCTypesByName(dbName, typename, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCTypesByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$typename = typename_example; // String | Type name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $typename = typename_example; # String | Type name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
typename = typename_example # String | Type name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_c_types_by_name(dbName, typename, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCTypesByName: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let typename = typename_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCTypesByName(dbName, typename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
typename*
String
Type name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCVariables

Get all C variables


/code/c/variables/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/variables/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCVariables(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCVariables");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCVariables(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCVariables");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCVariablesWith:dbName
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCVariables(dbName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCVariables: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_c_variables(dbName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCVariables: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCVariables(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCVariablesByName

Get C variables by name


/code/c/variables/{dbName}/{varname}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/variables/{dbName}/{varname}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String varname = varname_example; // String | Variable name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCVariablesByName(dbName, varname, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCVariablesByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String varname = varname_example; // String | Variable name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getCVariablesByName(dbName, varname, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getCVariablesByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *varname = varname_example; // Variable name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCVariablesByNameWith:dbName
    varname:varname
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var varname = varname_example; // {String} Variable name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var varname = varname_example;  // String | Variable name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getCVariablesByName(dbName, varname, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getCVariablesByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$varname = varname_example; // String | Variable name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $varname = varname_example; # String | Variable name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
varname = varname_example # String | Variable name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_c_variables_by_name(dbName, varname, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getCVariablesByName: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let varname = varname_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getCVariablesByName(dbName, varname, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
varname*
String
Variable name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaAnnotations

Get all Java annotations documents from the database


/code/java/annotations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/annotations/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaAnnotations(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaAnnotations(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getJavaAnnotationsWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[Object] result = apiInstance.getJavaAnnotations(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getJavaAnnotations($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getJavaAnnotations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getJavaAnnotations(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getJavaAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_java_annotations(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getJavaAnnotations(dbName, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaAnnotationsBySourceCodeFilename

Get the Java annotations documents related to a Java source code file from the database


/code/java/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/annotations/{dbName}/{filename}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Java Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getJavaAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Java Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Java Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[Object] result = apiInstance.getJavaAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Java Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getJavaAnnotationsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getJavaAnnotationsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Java Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getJavaAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getJavaAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Java Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_java_annotations_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getJavaAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Java Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaClassFields

Get all fields from a Java class


/code/java/class/fields/{dbName}/{className}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/class/fields/{dbName}/{className}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getJavaClassFields(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaClassFields");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getJavaClassFields(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaClassFields");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *className = className_example; // class name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getJavaClassFieldsWith:dbName
    className:className
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var className = className_example; // {String} class name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var className = className_example;  // String | class name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getJavaClassFields(dbName, className, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaClassFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$className = className_example; // String | class name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $className = className_example; # String | class name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
className = className_example # String | class name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_java_class_fields(dbName, className, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaClassFields: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let className = className_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getJavaClassFields(dbName, className, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
className*
String
class name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaClassMethods

Get all methods from a Java class


/code/java/class/methods/{dbName}/{className}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/class/methods/{dbName}/{className}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getJavaClassMethods(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaClassMethods");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getJavaClassMethods(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaClassMethods");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *className = className_example; // class name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getJavaClassMethodsWith:dbName
    className:className
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var className = className_example; // {String} class name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var className = className_example;  // String | class name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getJavaClassMethods(dbName, className, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaClassMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$className = className_example; // String | class name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $className = className_example; # String | class name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
className = className_example # String | class name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_java_class_methods(dbName, className, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaClassMethods: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let className = className_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getJavaClassMethods(dbName, className, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
className*
String
class name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaClasses

Get all Java classes


/code/java/classes/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/classes/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getJavaClasses(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaClasses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getJavaClasses(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaClasses");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getJavaClassesWith:dbName
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getJavaClasses(dbName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaClasses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_java_classes(dbName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaClasses: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CodeApi::Context::default();
    let result = client.getJavaClasses(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaComments

Get all Java comments documents from the database


/code/java/comments/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/comments/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmJavaComments] result = apiInstance.getJavaComments(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmJavaComments] result = apiInstance.getJavaComments(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getJavaCommentsWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmJavaComments] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmJavaComments] result = apiInstance.getJavaComments(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getJavaComments($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getJavaComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getJavaComments(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getJavaComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_java_comments(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getJavaComments(dbName, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaCommentsBySourceCodeFilename

Get the Java comments documents related to a Java source code file from the database


/code/java/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/comments/{dbName}/{filename}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmJavaComments] result = apiInstance.getJavaCommentsBySourceCodeFilename(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmJavaComments] result = apiInstance.getJavaCommentsBySourceCodeFilename(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Java Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getJavaCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmJavaComments] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Java Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Java Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmJavaComments] result = apiInstance.getJavaCommentsBySourceCodeFilename(dbName, filename, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Java Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getJavaCommentsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getJavaCommentsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Java Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getJavaCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getJavaCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Java Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_java_comments_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getJavaCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Java Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaSourceCodes

Get all Java source code documents (Abstract Syntax Tree) from the database


/code/java/sourcecode/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/sourcecode/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaSourceCodes(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaSourceCodes(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getJavaSourceCodesWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[Object] result = apiInstance.getJavaSourceCodes(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getJavaSourceCodes($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getJavaSourceCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getJavaSourceCodes(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getJavaSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_java_source_codes(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getJavaSourceCodes(dbName, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJavaSourceCodesBySourceCodeFilename

Get the Java source code documents (Abstract Syntax Tree) related to a Java source code file from the database


/code/java/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/sourcecode/{dbName}/{filename}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Java Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getJavaSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getJavaSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Java Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getJavaSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Java Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Java Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[Object] result = apiInstance.getJavaSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getJavaSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Java Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getJavaSourceCodesBySourceCodeFilename($dbName, $filename, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getJavaSourceCodesBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Java Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getJavaSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getJavaSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Java Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_java_source_codes_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getJavaSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getJavaSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Java Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getRawSourceCode

Get a single source code file from the database


/code/rawsourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/rawsourcecode/{dbName}/{filename}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getRawSourceCode(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getRawSourceCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getRawSourceCode(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getRawSourceCode");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getRawSourceCodeWith:dbName
    filename:filename
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmFile result = apiInstance.getRawSourceCode(dbName, filename, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getRawSourceCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getRawSourceCode($dbName, $filename, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getRawSourceCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getRawSourceCode(dbName => $dbName, filename => $filename, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getRawSourceCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_raw_source_code(dbName, filename, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getRawSourceCode: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getRawSourceCode(dbName, filename, key, abbrev, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getRawSourceCodes

Get all source code files from the database


/code/rawsourcecode/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/rawsourcecode/{dbName}?abbrev=true&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getRawSourceCodes(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getRawSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getRawSourceCodes(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getRawSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getRawSourceCodesWith:dbName
    key:key
    abbrev:abbrev
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmFile] result = apiInstance.getRawSourceCodes(dbName, key, abbrev, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getRawSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getRawSourceCodes($dbName, $key, $abbrev, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getRawSourceCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getRawSourceCodes(dbName => $dbName, key => $key, abbrev => $abbrev, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getRawSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_raw_source_codes(dbName, key, abbrev=abbrev, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getRawSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CodeApi::Context::default();
    let result = client.getRawSourceCodes(dbName, key, abbrev, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getSourceCodeAnnotations

Get all source code annotations documents from the database


/code/annotations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/annotations/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeAnnotations] result = apiInstance.getSourceCodeAnnotations(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeAnnotations] result = apiInstance.getSourceCodeAnnotations(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getSourceCodeAnnotationsWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmSourceCodeAnnotations] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmSourceCodeAnnotations] result = apiInstance.getSourceCodeAnnotations(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getSourceCodeAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getSourceCodeAnnotations($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getSourceCodeAnnotations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getSourceCodeAnnotations(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getSourceCodeAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_source_code_annotations(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getSourceCodeAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getSourceCodeAnnotations(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getSourceCodeAnnotationsBySourceCodeFilename

Get the source code annotations documents related to a source code file from the database


/code/annotations/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/annotations/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeAnnotations] result = apiInstance.getSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeAnnotations] result = apiInstance.getSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeAnnotationsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getSourceCodeAnnotationsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmSourceCodeAnnotations] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmSourceCodeAnnotations] result = apiInstance.getSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getSourceCodeAnnotationsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getSourceCodeAnnotationsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getSourceCodeAnnotationsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getSourceCodeAnnotationsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getSourceCodeAnnotationsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_source_code_annotations_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getSourceCodeAnnotationsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getSourceCodeAnnotationsBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getSourceCodeComments

Get all source code comments documents from the database


/code/comments/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/comments/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeComment] result = apiInstance.getSourceCodeComments(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeComment] result = apiInstance.getSourceCodeComments(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getSourceCodeCommentsWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmSourceCodeComment] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmSourceCodeComment] result = apiInstance.getSourceCodeComments(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getSourceCodeComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getSourceCodeComments($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getSourceCodeComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getSourceCodeComments(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getSourceCodeComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_source_code_comments(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getSourceCodeComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getSourceCodeComments(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getSourceCodeCommentsBySourceCodeFilename

Get the source code comments documents related to a source code file from the database


/code/comments/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/comments/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeComment] result = apiInstance.getSourceCodeCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCodeComment] result = apiInstance.getSourceCodeCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodeCommentsBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getSourceCodeCommentsBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmSourceCodeComment] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmSourceCodeComment] result = apiInstance.getSourceCodeCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getSourceCodeCommentsBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getSourceCodeCommentsBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getSourceCodeCommentsBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getSourceCodeCommentsBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getSourceCodeCommentsBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_source_code_comments_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getSourceCodeCommentsBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getSourceCodeCommentsBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getSourceCodes

Get all source code documents (Abstract Syntax Tree) from the database


/code/sourcecode/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/sourcecode/{dbName}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCode] result = apiInstance.getSourceCodes(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCode] result = apiInstance.getSourceCodes(dbName, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getSourceCodesWith:dbName
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmSourceCode] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmSourceCode] result = apiInstance.getSourceCodes(dbName, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getSourceCodes($dbName, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getSourceCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getSourceCodes(dbName => $dbName, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_source_codes(dbName, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getSourceCodes(dbName, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getSourceCodesBySourceCodeFilename

Get the source code documents (Abstract Syntax Tree) related to a source code file from the database


/code/sourcecode/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/code/sourcecode/{dbName}/{filename}?skip=56&limit=56&merge=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCode] result = apiInstance.getSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Source code filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        Boolean merge = true; // Boolean | enable/disable merging according to file

        try {
            array[PkmSourceCode] result = apiInstance.getSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#getSourceCodesBySourceCodeFilename");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Source code filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
Boolean *merge = true; // enable/disable merging according to file (optional) (default to true)

[apiInstance getSourceCodesBySourceCodeFilenameWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
    merge:merge
              completionHandler: ^(array[PkmSourceCode] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Source code filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'merge': true // {Boolean} enable/disable merging according to file
};

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Source code filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var merge = true;  // Boolean | enable/disable merging according to file (optional)  (default to true)

            try {
                array[PkmSourceCode] result = apiInstance.getSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.getSourceCodesBySourceCodeFilename: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Source code filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$merge = true; // Boolean | enable/disable merging according to file

try {
    $result = $api_instance->getSourceCodesBySourceCodeFilename($dbName, $filename, $key, $skip, $limit, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->getSourceCodesBySourceCodeFilename: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CodeApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Source code filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $merge = true; # Boolean | enable/disable merging according to file

eval {
    my $result = $api_instance->getSourceCodesBySourceCodeFilename(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit, merge => $merge);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->getSourceCodesBySourceCodeFilename: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Source code filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
merge = true # Boolean | enable/disable merging according to file (optional) (default to true)

try:
    api_response = api_instance.get_source_codes_by_source_code_filename(dbName, filename, key, skip=skip, limit=limit, merge=merge)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->getSourceCodesBySourceCodeFilename: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer
    let merge = true; // Boolean

    let mut context = CodeApi::Context::default();
    let result = client.getSourceCodesBySourceCodeFilename(dbName, filename, key, skip, limit, merge, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Source code filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
merge
Boolean
enable/disable merging according to file

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postJavaSourceCodes

Insert some Java source code (AST)


/code/java/sourcecode/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/sourcecode/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.postJavaSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#postJavaSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.postJavaSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#postJavaSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[Object] *body = ; // 

[apiInstance postJavaSourceCodesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[Object]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[Object](); // array[Object] | 

            try {
                apiInstance.postJavaSourceCodes(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.postJavaSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[Object] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[Object]->new()]; # array[Object] | 

eval {
    $api_instance->postJavaSourceCodes(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->postJavaSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[Object] | 

try:
    api_instance.post_java_source_codes(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->postJavaSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[Object]

    let mut context = CodeApi::Context::default();
    let result = client.postJavaSourceCodes(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Java source code documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postRawSourceCodes

Insert some source code files (which are not yet present) into the database. The related documents (source code AST, comments and annotations) which originate from the source code files are invalidated.


/code/rawsourcecode/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/rawsourcecode/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postRawSourceCodes(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#postRawSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postRawSourceCodes(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#postRawSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance postRawSourceCodesWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                'String' result = apiInstance.postRawSourceCodes(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.postRawSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

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

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_response = api_instance.post_raw_source_codes(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->postRawSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = CodeApi::Context::default();
    let result = client.postRawSourceCodes(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Source code files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCAnnotations

Put some C annotations documents into the database


/code/c/annotations/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/annotations/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.putCAnnotations(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.putCAnnotations(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[Object] *body = ; // 

[apiInstance putCAnnotationsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[Object]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[Object](); // array[Object] | 

            try {
                apiInstance.putCAnnotations(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putCAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[Object] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[Object]->new()]; # array[Object] | 

eval {
    $api_instance->putCAnnotations(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putCAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[Object] | 

try:
    api_instance.put_c_annotations(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putCAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[Object]

    let mut context = CodeApi::Context::default();
    let result = client.putCAnnotations(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCComments

Put some C comments documents into the database


/code/c/comments/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/comments/{dbName}" \
 -d '{
  "comments" : [ {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      },
      "pos_end" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      }
    },
    "comments" : [ "comments", "comments" ]
  }, {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      },
      "pos_end" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      }
    },
    "comments" : [ "comments", "comments" ]
  } ],
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCComments] body = ; // array[PkmCComments] | 

        try {
            apiInstance.putCComments(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCComments] body = ; // array[PkmCComments] | 

        try {
            apiInstance.putCComments(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCComments] *body = ; // 

[apiInstance putCCommentsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCComments]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCComments](); // array[PkmCComments] | 

            try {
                apiInstance.putCComments(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putCComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCComments] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCComments]->new()]; # array[PkmCComments] | 

eval {
    $api_instance->putCComments(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putCComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCComments] | 

try:
    api_instance.put_c_comments(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putCComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCComments]

    let mut context = CodeApi::Context::default();
    let result = client.putCComments(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

C comments documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCPPAnnotations

Put some C++ annotations documents into the database


/code/cpp/annotations/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/annotations/{dbName}" \
 -d '{
  "annotations" : [ {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      },
      "pos_end" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      }
    },
    "annotations" : [ "annotations", "annotations" ],
    "id" : 5.962133916683182
  }, {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      },
      "pos_end" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      }
    },
    "annotations" : [ "annotations", "annotations" ],
    "id" : 5.962133916683182
  } ],
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCppAnnotations] body = ; // array[PkmCppAnnotations] | 

        try {
            apiInstance.putCPPAnnotations(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCPPAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCppAnnotations] body = ; // array[PkmCppAnnotations] | 

        try {
            apiInstance.putCPPAnnotations(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCPPAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCppAnnotations] *body = ; // 

[apiInstance putCPPAnnotationsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCppAnnotations]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCppAnnotations](); // array[PkmCppAnnotations] | 

            try {
                apiInstance.putCPPAnnotations(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putCPPAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCppAnnotations] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCppAnnotations]->new()]; # array[PkmCppAnnotations] | 

eval {
    $api_instance->putCPPAnnotations(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putCPPAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCppAnnotations] | 

try:
    api_instance.put_cpp_annotations(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putCPPAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCppAnnotations]

    let mut context = CodeApi::Context::default();
    let result = client.putCPPAnnotations(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCPPComments

Put some C++ comments documents into the database


/code/cpp/comments/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/comments/{dbName}" \
 -d '{
  "comments" : [ {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      },
      "pos_end" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      }
    },
    "comments" : [ null, null ],
    "id" : 5.962133916683182
  }, {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      },
      "pos_end" : {
        "pos_cnum" : 1.4658129805029452,
        "pos_bol" : 6.027456183070403,
        "pos_path" : "pos_path",
        "pos_lnum" : 0.8008281904610115
      }
    },
    "comments" : [ null, null ],
    "id" : 5.962133916683182
  } ],
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCppComments] body = ; // array[PkmCppComments] | 

        try {
            apiInstance.putCPPComments(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCPPComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCppComments] body = ; // array[PkmCppComments] | 

        try {
            apiInstance.putCPPComments(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCPPComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCppComments] *body = ; // 

[apiInstance putCPPCommentsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCppComments]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCppComments](); // array[PkmCppComments] | 

            try {
                apiInstance.putCPPComments(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putCPPComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCppComments] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCppComments]->new()]; # array[PkmCppComments] | 

eval {
    $api_instance->putCPPComments(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putCPPComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCppComments] | 

try:
    api_instance.put_cpp_comments(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putCPPComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCppComments]

    let mut context = CodeApi::Context::default();
    let result = client.putCPPComments(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

C++ comments documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCPPSourceCodes

Put some C++ source code documents (Abstract Syntax Tree) into the database


/code/cpp/sourcecode/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/cpp/sourcecode/{dbName}" \
 -d '{
  "type" : "type",
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCppSourceCode] body = ; // array[PkmCppSourceCode] | 

        try {
            apiInstance.putCPPSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCPPSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCppSourceCode] body = ; // array[PkmCppSourceCode] | 

        try {
            apiInstance.putCPPSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCPPSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCppSourceCode] *body = ; // 

[apiInstance putCPPSourceCodesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCppSourceCode]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCppSourceCode](); // array[PkmCppSourceCode] | 

            try {
                apiInstance.putCPPSourceCodes(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putCPPSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCppSourceCode] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCppSourceCode]->new()]; # array[PkmCppSourceCode] | 

eval {
    $api_instance->putCPPSourceCodes(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putCPPSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCppSourceCode] | 

try:
    api_instance.put_cpp_source_codes(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putCPPSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCppSourceCode]

    let mut context = CodeApi::Context::default();
    let result = client.putCPPSourceCodes(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

C++ source code documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCSourceCodes

Put some C source code documents (Abstract Syntax Tree) into the database


/code/c/sourcecode/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/c/sourcecode/{dbName}" \
 -d '{
  "globinitcalled" : true,
  "globinit" : { },
  "globals" : [ {
    "key" : "{}"
  }, {
    "key" : "{}"
  } ],
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCSourceCode] body = ; // array[PkmCSourceCode] | 

        try {
            apiInstance.putCSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCSourceCode] body = ; // array[PkmCSourceCode] | 

        try {
            apiInstance.putCSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putCSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCSourceCode] *body = ; // 

[apiInstance putCSourceCodesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCSourceCode]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCSourceCode](); // array[PkmCSourceCode] | 

            try {
                apiInstance.putCSourceCodes(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putCSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCSourceCode] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCSourceCode]->new()]; # array[PkmCSourceCode] | 

eval {
    $api_instance->putCSourceCodes(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putCSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCSourceCode] | 

try:
    api_instance.put_c_source_codes(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putCSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCSourceCode]

    let mut context = CodeApi::Context::default();
    let result = client.putCSourceCodes(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

C source code documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putJavaAnnotations

Put some Java annotations documents into the database


/code/java/annotations/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/annotations/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.putJavaAnnotations(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putJavaAnnotations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.putJavaAnnotations(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putJavaAnnotations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[Object] *body = ; // 

[apiInstance putJavaAnnotationsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[Object]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[Object](); // array[Object] | 

            try {
                apiInstance.putJavaAnnotations(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putJavaAnnotations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[Object] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[Object]->new()]; # array[Object] | 

eval {
    $api_instance->putJavaAnnotations(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putJavaAnnotations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[Object] | 

try:
    api_instance.put_java_annotations(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putJavaAnnotations: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[Object]

    let mut context = CodeApi::Context::default();
    let result = client.putJavaAnnotations(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putJavaComments

Put some Java comments documents into the database


/code/java/comments/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/comments/{dbName}" \
 -d '{
  "comments" : [ {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 0,
        "pos_lnum" : 6
      },
      "pos_end" : {
        "pos_cnum" : 0,
        "pos_lnum" : 6
      }
    },
    "comments" : [ "comments", "comments" ],
    "commentInEnvironment" : "commentInEnvironment"
  }, {
    "loc" : {
      "pos_start" : {
        "pos_cnum" : 0,
        "pos_lnum" : 6
      },
      "pos_end" : {
        "pos_cnum" : 0,
        "pos_lnum" : 6
      }
    },
    "comments" : [ "comments", "comments" ],
    "commentInEnvironment" : "commentInEnvironment"
  } ],
  "fileEncoding" : "fileEncoding",
  "fileMimeType" : "fileMimeType",
  "type" : "type",
  "sourceFile" : "sourceFile",
  "fileFormat" : "fileFormat"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmJavaComments] body = ; // array[PkmJavaComments] | 

        try {
            apiInstance.putJavaComments(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putJavaComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmJavaComments] body = ; // array[PkmJavaComments] | 

        try {
            apiInstance.putJavaComments(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putJavaComments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmJavaComments] *body = ; // 

[apiInstance putJavaCommentsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmJavaComments]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmJavaComments](); // array[PkmJavaComments] | 

            try {
                apiInstance.putJavaComments(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putJavaComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmJavaComments] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmJavaComments]->new()]; # array[PkmJavaComments] | 

eval {
    $api_instance->putJavaComments(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putJavaComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmJavaComments] | 

try:
    api_instance.put_java_comments(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putJavaComments: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmJavaComments]

    let mut context = CodeApi::Context::default();
    let result = client.putJavaComments(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Java comments documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putJavaSourceCodes

Put some Java source code (AST)


/code/java/sourcecode/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/java/sourcecode/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.putJavaSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putJavaSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            apiInstance.putJavaSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putJavaSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[Object] *body = ; // 

[apiInstance putJavaSourceCodesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[Object]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[Object](); // array[Object] | 

            try {
                apiInstance.putJavaSourceCodes(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putJavaSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[Object] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[Object]->new()]; # array[Object] | 

eval {
    $api_instance->putJavaSourceCodes(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putJavaSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[Object] | 

try:
    api_instance.put_java_source_codes(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putJavaSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[Object]

    let mut context = CodeApi::Context::default();
    let result = client.putJavaSourceCodes(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Java source code documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putRawSourceCodes

Insert (if not yet present) or update (if already present) some source code files into the database. The related documents (source code AST, comments and annotations) which originate from the source code files are invalidated.


/code/rawsourcecode/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/code/rawsourcecode/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CodeApi;

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

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

        // Create an instance of the API class
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putRawSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putRawSourceCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CodeApi;

public class CodeApiExample {
    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putRawSourceCodes(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#putRawSourceCodes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CodeApi *apiInstance = [[CodeApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance putRawSourceCodesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CodeApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CodeApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                apiInstance.putRawSourceCodes(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CodeApi.putRawSourceCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CodeApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CodeApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    $api_instance->putRawSourceCodes(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CodeApi->putRawSourceCodes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CodeApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_instance.put_raw_source_codes(dbName, key, body)
except ApiException as e:
    print("Exception when calling CodeApi->putRawSourceCodes: %s\n" % e)
extern crate CodeApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = CodeApi::Context::default();
    let result = client.putRawSourceCodes(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Source code files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

CompileCommand

deleteCompileCommand

delete the compile command document related to a file from the database


/compile_command/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/compile_command/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompileCommandApi;

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

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

        // Create an instance of the API class
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | the filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCompileCommand(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#deleteCompileCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompileCommandApi;

public class CompileCommandApiExample {
    public static void main(String[] args) {
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | the filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCompileCommand(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#deleteCompileCommand");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CompileCommandApi *apiInstance = [[CompileCommandApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // the filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCompileCommandWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CompileCommandApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} the filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CompileCommandApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | the filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteCompileCommand(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompileCommandApi.deleteCompileCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompileCommandApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | the filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompileCommandApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | the filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteCompileCommand(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling CompileCommandApi->deleteCompileCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CompileCommandApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | the filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_compile_command(dbName, filename, key)
except ApiException as e:
    print("Exception when calling CompileCommandApi->deleteCompileCommand: %s\n" % e)
extern crate CompileCommandApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = CompileCommandApi::Context::default();
    let result = client.deleteCompileCommand(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
the filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteCompileCommands

Delete all compile command documents in the database


/compile_command/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/compile_command/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompileCommandApi;

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

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

        // Create an instance of the API class
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCompileCommands(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#deleteCompileCommands");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompileCommandApi;

public class CompileCommandApiExample {
    public static void main(String[] args) {
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteCompileCommands(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#deleteCompileCommands");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CompileCommandApi *apiInstance = [[CompileCommandApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteCompileCommandsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CompileCommandApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new CompileCommandApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompileCommandApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompileCommandApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.CompileCommandApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_compile_commands(dbName, key)
except ApiException as e:
    print("Exception when calling CompileCommandApi->deleteCompileCommands: %s\n" % e)
extern crate CompileCommandApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = CompileCommandApi::Context::default();
    let result = client.deleteCompileCommands(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCompileCommand

Get the compile commands documents related to a file from the database


/compile_command/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/compile_command/{dbName}/{filename}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompileCommandApi;

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

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

        // Create an instance of the API class
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | the filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmCompileCommand] result = apiInstance.getCompileCommand(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#getCompileCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompileCommandApi;

public class CompileCommandApiExample {
    public static void main(String[] args) {
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | the filename
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmCompileCommand] result = apiInstance.getCompileCommand(dbName, filename, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#getCompileCommand");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CompileCommandApi *apiInstance = [[CompileCommandApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // the filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getCompileCommandWith:dbName
    filename:filename
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmCompileCommand] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CompileCommandApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} the filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CompileCommandApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | the filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmCompileCommand] result = apiInstance.getCompileCommand(dbName, filename, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompileCommandApi.getCompileCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompileCommandApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | the filename
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getCompileCommand($dbName, $filename, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompileCommandApi->getCompileCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompileCommandApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompileCommandApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | the filename
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getCompileCommand(dbName => $dbName, filename => $filename, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompileCommandApi->getCompileCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CompileCommandApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | the filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_compile_command(dbName, filename, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompileCommandApi->getCompileCommand: %s\n" % e)
extern crate CompileCommandApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CompileCommandApi::Context::default();
    let result = client.getCompileCommand(dbName, filename, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
the filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCompileCommands

Get all compile command documents from the database


/compile_command/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/compile_command/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompileCommandApi;

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

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

        // Create an instance of the API class
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmCompileCommand] result = apiInstance.getCompileCommands(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#getCompileCommands");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompileCommandApi;

public class CompileCommandApiExample {
    public static void main(String[] args) {
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmCompileCommand] result = apiInstance.getCompileCommands(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#getCompileCommands");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CompileCommandApi *apiInstance = [[CompileCommandApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getCompileCommandsWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmCompileCommand] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CompileCommandApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new CompileCommandApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmCompileCommand] result = apiInstance.getCompileCommands(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompileCommandApi.getCompileCommands: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompileCommandApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getCompileCommands($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompileCommandApi->getCompileCommands: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompileCommandApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompileCommandApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getCompileCommands(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompileCommandApi->getCompileCommands: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CompileCommandApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_compile_commands(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompileCommandApi->getCompileCommands: %s\n" % e)
extern crate CompileCommandApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = CompileCommandApi::Context::default();
    let result = client.getCompileCommands(dbName, key, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postCompileCommands

Post some compile commands into the database


/compile_command/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/compile_command/{dbName}" \
 -d 'null'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompileCommandApi;

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

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

        // Create an instance of the API class
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCompileCommand] body = ; // array[PkmCompileCommand] | 

        try {
            apiInstance.postCompileCommands(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#postCompileCommands");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompileCommandApi;

public class CompileCommandApiExample {
    public static void main(String[] args) {
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCompileCommand] body = ; // array[PkmCompileCommand] | 

        try {
            apiInstance.postCompileCommands(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#postCompileCommands");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CompileCommandApi *apiInstance = [[CompileCommandApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCompileCommand] *body = ; // 

[apiInstance postCompileCommandsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CompileCommandApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCompileCommand]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CompileCommandApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCompileCommand](); // array[PkmCompileCommand] | 

            try {
                apiInstance.postCompileCommands(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompileCommandApi.postCompileCommands: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompileCommandApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCompileCommand] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompileCommandApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCompileCommand]->new()]; # array[PkmCompileCommand] | 

eval {
    $api_instance->postCompileCommands(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CompileCommandApi->postCompileCommands: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CompileCommandApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCompileCommand] | 

try:
    api_instance.post_compile_commands(dbName, key, body)
except ApiException as e:
    print("Exception when calling CompileCommandApi->postCompileCommands: %s\n" % e)
extern crate CompileCommandApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCompileCommand]

    let mut context = CompileCommandApi::Context::default();
    let result = client.postCompileCommands(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Compile command documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putCompileCommands

Put some compile commands into the database


/compile_command/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/compile_command/{dbName}" \
 -d 'null'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompileCommandApi;

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

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

        // Create an instance of the API class
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCompileCommand] body = ; // array[PkmCompileCommand] | 

        try {
            apiInstance.putCompileCommands(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#putCompileCommands");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompileCommandApi;

public class CompileCommandApiExample {
    public static void main(String[] args) {
        CompileCommandApi apiInstance = new CompileCommandApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmCompileCommand] body = ; // array[PkmCompileCommand] | 

        try {
            apiInstance.putCompileCommands(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompileCommandApi#putCompileCommands");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CompileCommandApi *apiInstance = [[CompileCommandApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmCompileCommand] *body = ; // 

[apiInstance putCompileCommandsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.CompileCommandApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmCompileCommand]} 

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

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

            // Create an instance of the API class
            var apiInstance = new CompileCommandApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmCompileCommand](); // array[PkmCompileCommand] | 

            try {
                apiInstance.putCompileCommands(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompileCommandApi.putCompileCommands: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompileCommandApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmCompileCommand] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompileCommandApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmCompileCommand]->new()]; # array[PkmCompileCommand] | 

eval {
    $api_instance->putCompileCommands(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling CompileCommandApi->putCompileCommands: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CompileCommandApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmCompileCommand] | 

try:
    api_instance.put_compile_commands(dbName, key, body)
except ApiException as e:
    print("Exception when calling CompileCommandApi->putCompileCommands: %s\n" % e)
extern crate CompileCommandApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmCompileCommand]

    let mut context = CompileCommandApi::Context::default();
    let result = client.putCompileCommands(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Compile command documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Db

deleteDatabase

drop database


/db/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/db/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbApi;

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

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

        // Create an instance of the API class
        DbApi apiInstance = new DbApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteDatabase(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbApi#deleteDatabase");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DbApi;

public class DbApiExample {
    public static void main(String[] args) {
        DbApi apiInstance = new DbApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteDatabase(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbApi#deleteDatabase");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DbApi *apiInstance = [[DbApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteDatabaseWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DbApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new DbApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.DbApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_database(dbName, key)
except ApiException as e:
    print("Exception when calling DbApi->deleteDatabase: %s\n" % e)
extern crate DbApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = DbApi::Context::default();
    let result = client.deleteDatabase(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postDatabase

create a new database


/db

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/db" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DbApi;

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

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

        // Create an instance of the API class
        DbApi apiInstance = new DbApi();
        String key = key_example; // String | Access key to the PKM
        InlineObject2 body = ; // InlineObject2 | 

        try {
            'String' result = apiInstance.postDatabase(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbApi#postDatabase");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DbApi;

public class DbApiExample {
    public static void main(String[] args) {
        DbApi apiInstance = new DbApi();
        String key = key_example; // String | Access key to the PKM
        InlineObject2 body = ; // InlineObject2 | 

        try {
            'String' result = apiInstance.postDatabase(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DbApi#postDatabase");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DbApi *apiInstance = [[DbApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)
InlineObject2 *body = ; // 

[apiInstance postDatabaseWith:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DbApi()
var key = key_example; // {String} Access key to the PKM
var body = ; // {InlineObject2} 

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

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

            // Create an instance of the API class
            var apiInstance = new DbApi();
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new InlineObject2(); // InlineObject2 | 

            try {
                'String' result = apiInstance.postDatabase(key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DbApi.postDatabase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DbApi();
$key = key_example; // String | Access key to the PKM
$body = ; // InlineObject2 | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DbApi->new();
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::InlineObject2->new(); # InlineObject2 | 

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

# Create an instance of the API class
api_instance = openapi_client.DbApi()
key = key_example # String | Access key to the PKM (default to null)
body =  # InlineObject2 | 

try:
    api_response = api_instance.post_database(key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DbApi->postDatabase: %s\n" % e)
extern crate DbApi;

pub fn main() {
    let key = key_example; // String
    let body = ; // InlineObject2

    let mut context = DbApi::Context::default();
    let result = client.postDatabase(key, body, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Doc

deleteDocs

Delete ASFM documents present in the database


/doc/asfm/docs/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/asfm/docs/{dbName}?doc=doc_example&filename=filename_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String doc = doc_example; // String | ASFM document name as a bare character string or a /regular expression/
        String filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/

        try {
            apiInstance.deleteDocs(dbName, key, doc, filename);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String doc = doc_example; // String | ASFM document name as a bare character string or a /regular expression/
        String filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/

        try {
            apiInstance.deleteDocs(dbName, key, doc, filename);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *doc = doc_example; // ASFM document name as a bare character string or a /regular expression/ (optional) (default to null)
String *filename = filename_example; // related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional) (default to null)

[apiInstance deleteDocsWith:dbName
    key:key
    doc:doc
    filename:filename
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'doc': doc_example, // {String} ASFM document name as a bare character string or a /regular expression/
  'filename': filename_example // {String} related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var doc = doc_example;  // String | ASFM document name as a bare character string or a /regular expression/ (optional)  (default to null)
            var filename = filename_example;  // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional)  (default to null)

            try {
                apiInstance.deleteDocs(dbName, key, doc, filename);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.deleteDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$doc = doc_example; // String | ASFM document name as a bare character string or a /regular expression/
$filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/

try {
    $api_instance->deleteDocs($dbName, $key, $doc, $filename);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->deleteDocs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $doc = doc_example; # String | ASFM document name as a bare character string or a /regular expression/
my $filename = filename_example; # String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/

eval {
    $api_instance->deleteDocs(dbName => $dbName, key => $key, doc => $doc, filename => $filename);
};
if ($@) {
    warn "Exception when calling DocApi->deleteDocs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
doc = doc_example # String | ASFM document name as a bare character string or a /regular expression/ (optional) (default to null)
filename = filename_example # String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional) (default to null)

try:
    api_instance.delete_docs(dbName, key, doc=doc, filename=filename)
except ApiException as e:
    print("Exception when calling DocApi->deleteDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let doc = doc_example; // String
    let filename = filename_example; // String

    let mut context = DocApi::Context::default();
    let result = client.deleteDocs(dbName, key, doc, filename, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
doc
String
ASFM document name as a bare character string or a /regular expression/
filename
String
related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteGraphicalDocs

Delete GSL documents present in the database


/doc/gsl/docs/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/gsl/docs/{dbName}?class=class_example&object=object_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String class = class_example; // String | GSL class name
        String object = object_example; // String | GSL object name

        try {
            apiInstance.deleteGraphicalDocs(dbName, key, class, object);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteGraphicalDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String class = class_example; // String | GSL class name
        String object = object_example; // String | GSL object name

        try {
            apiInstance.deleteGraphicalDocs(dbName, key, class, object);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteGraphicalDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *class = class_example; // GSL class name (optional) (default to null)
String *object = object_example; // GSL object name (optional) (default to null)

[apiInstance deleteGraphicalDocsWith:dbName
    key:key
    class:class
    object:object
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'class': class_example, // {String} GSL class name
  'object': object_example // {String} GSL object name
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var class = class_example;  // String | GSL class name (optional)  (default to null)
            var object = object_example;  // String | GSL object name (optional)  (default to null)

            try {
                apiInstance.deleteGraphicalDocs(dbName, key, class, object);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.deleteGraphicalDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$class = class_example; // String | GSL class name
$object = object_example; // String | GSL object name

try {
    $api_instance->deleteGraphicalDocs($dbName, $key, $class, $object);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->deleteGraphicalDocs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $class = class_example; # String | GSL class name
my $object = object_example; # String | GSL object name

eval {
    $api_instance->deleteGraphicalDocs(dbName => $dbName, key => $key, class => $class, object => $object);
};
if ($@) {
    warn "Exception when calling DocApi->deleteGraphicalDocs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
class = class_example # String | GSL class name (optional) (default to null)
object = object_example # String | GSL object name (optional) (default to null)

try:
    api_instance.delete_graphical_docs(dbName, key, class=class, object=object)
except ApiException as e:
    print("Exception when calling DocApi->deleteGraphicalDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let class = class_example; // String
    let object = object_example; // String

    let mut context = DocApi::Context::default();
    let result = client.deleteGraphicalDocs(dbName, key, class, object, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
class
String
GSL class name
object
String
GSL object name

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteRawDoc

delete a Documentation file from the database


/doc/rawdoc/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/rawdoc/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Documentation filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawDoc(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteRawDoc");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Documentation filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawDoc(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteRawDoc");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Documentation filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteRawDocWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Documentation filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Documentation filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteRawDoc(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.deleteRawDoc: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Documentation filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Documentation filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteRawDoc(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling DocApi->deleteRawDoc: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Documentation filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_raw_doc(dbName, filename, key)
except ApiException as e:
    print("Exception when calling DocApi->deleteRawDoc: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = DocApi::Context::default();
    let result = client.deleteRawDoc(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Documentation filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteRawDocs

Delete all Documentation files present in the database together with documents which originate from these Documentation files


/doc/rawdoc/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/rawdoc/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawDocs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteRawDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawDocs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#deleteRawDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteRawDocsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_raw_docs(dbName, key)
except ApiException as e:
    print("Exception when calling DocApi->deleteRawDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = DocApi::Context::default();
    let result = client.deleteRawDocs(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getDocArtefacts

Get ASFM artefacts from the database


/doc/asfm/artefacts/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/asfm/artefacts/{dbName}?id=1234&doc=doc_example&filename=filename_example&unit=unit_example&class=class_example&invariant=invariant_example&field=field_example&method=method_example&type=type_example¯o=macro_example&constant=constant_example&member=member_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        String doc = doc_example; // String | ASFM document name as bare character string or a /regular expression/
        String filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
        String unit = unit_example; // String | unit name as bare character string or a /regular expression/
        String class = class_example; // String | class name as bare character string or a /regular expression/
        String invariant = invariant_example; // String | invariant name as bare character string or a /regular expression/
        String field = field_example; // String | field name as bare character string or a /regular expression/
        String method = method_example; // String | method name as bare character string or a /regular expression/
        String type = type_example; // String | type name as bare character string or a /regular expression/
        String macro = macro_example; // String | macro name as bare character string or a /regular expression/
        String constant = constant_example; // String | constant name as bare character string or a /regular expression/
        String member = member_example; // String | member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getDocArtefacts(dbName, key, id, doc, filename, unit, class, invariant, field, method, type, macro, constant, member, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getDocArtefacts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer id = 1234; // Integer | artefact identifier
        String doc = doc_example; // String | ASFM document name as bare character string or a /regular expression/
        String filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
        String unit = unit_example; // String | unit name as bare character string or a /regular expression/
        String class = class_example; // String | class name as bare character string or a /regular expression/
        String invariant = invariant_example; // String | invariant name as bare character string or a /regular expression/
        String field = field_example; // String | field name as bare character string or a /regular expression/
        String method = method_example; // String | method name as bare character string or a /regular expression/
        String type = type_example; // String | type name as bare character string or a /regular expression/
        String macro = macro_example; // String | macro name as bare character string or a /regular expression/
        String constant = constant_example; // String | constant name as bare character string or a /regular expression/
        String member = member_example; // String | member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getDocArtefacts(dbName, key, id, doc, filename, unit, class, invariant, field, method, type, macro, constant, member, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getDocArtefacts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *id = 1234; // artefact identifier (optional) (default to null)
String *doc = doc_example; // ASFM document name as bare character string or a /regular expression/ (optional) (default to null)
String *filename = filename_example; // related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional) (default to null)
String *unit = unit_example; // unit name as bare character string or a /regular expression/ (optional) (default to null)
String *class = class_example; // class name as bare character string or a /regular expression/ (optional) (default to null)
String *invariant = invariant_example; // invariant name as bare character string or a /regular expression/ (optional) (default to null)
String *field = field_example; // field name as bare character string or a /regular expression/ (optional) (default to null)
String *method = method_example; // method name as bare character string or a /regular expression/ (optional) (default to null)
String *type = type_example; // type name as bare character string or a /regular expression/ (optional) (default to null)
String *macro = macro_example; // macro name as bare character string or a /regular expression/ (optional) (default to null)
String *constant = constant_example; // constant name as bare character string or a /regular expression/ (optional) (default to null)
String *member = member_example; // member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/ (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getDocArtefactsWith:dbName
    key:key
    id:id
    doc:doc
    filename:filename
    unit:unit
    class:class
    invariant:invariant
    field:field
    method:method
    type:type
    macro:macro
    constant:constant
    member:member
    skip:skip
    limit:limit
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': 1234, // {Integer} artefact identifier
  'doc': doc_example, // {String} ASFM document name as bare character string or a /regular expression/
  'filename': filename_example, // {String} related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
  'unit': unit_example, // {String} unit name as bare character string or a /regular expression/
  'class': class_example, // {String} class name as bare character string or a /regular expression/
  'invariant': invariant_example, // {String} invariant name as bare character string or a /regular expression/
  'field': field_example, // {String} field name as bare character string or a /regular expression/
  'method': method_example, // {String} method name as bare character string or a /regular expression/
  'type': type_example, // {String} type name as bare character string or a /regular expression/
  'macro': macro_example, // {String} macro name as bare character string or a /regular expression/
  'constant': constant_example, // {String} constant name as bare character string or a /regular expression/
  'member': member_example, // {String} member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = 1234;  // Integer | artefact identifier (optional)  (default to null)
            var doc = doc_example;  // String | ASFM document name as bare character string or a /regular expression/ (optional)  (default to null)
            var filename = filename_example;  // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional)  (default to null)
            var unit = unit_example;  // String | unit name as bare character string or a /regular expression/ (optional)  (default to null)
            var class = class_example;  // String | class name as bare character string or a /regular expression/ (optional)  (default to null)
            var invariant = invariant_example;  // String | invariant name as bare character string or a /regular expression/ (optional)  (default to null)
            var field = field_example;  // String | field name as bare character string or a /regular expression/ (optional)  (default to null)
            var method = method_example;  // String | method name as bare character string or a /regular expression/ (optional)  (default to null)
            var type = type_example;  // String | type name as bare character string or a /regular expression/ (optional)  (default to null)
            var macro = macro_example;  // String | macro name as bare character string or a /regular expression/ (optional)  (default to null)
            var constant = constant_example;  // String | constant name as bare character string or a /regular expression/ (optional)  (default to null)
            var member = member_example;  // String | member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/ (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[Object] result = apiInstance.getDocArtefacts(dbName, key, id, doc, filename, unit, class, invariant, field, method, type, macro, constant, member, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.getDocArtefacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = 1234; // Integer | artefact identifier
$doc = doc_example; // String | ASFM document name as bare character string or a /regular expression/
$filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
$unit = unit_example; // String | unit name as bare character string or a /regular expression/
$class = class_example; // String | class name as bare character string or a /regular expression/
$invariant = invariant_example; // String | invariant name as bare character string or a /regular expression/
$field = field_example; // String | field name as bare character string or a /regular expression/
$method = method_example; // String | method name as bare character string or a /regular expression/
$type = type_example; // String | type name as bare character string or a /regular expression/
$macro = macro_example; // String | macro name as bare character string or a /regular expression/
$constant = constant_example; // String | constant name as bare character string or a /regular expression/
$member = member_example; // String | member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getDocArtefacts($dbName, $key, $id, $doc, $filename, $unit, $class, $invariant, $field, $method, $type, $macro, $constant, $member, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->getDocArtefacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = 1234; # Integer | artefact identifier
my $doc = doc_example; # String | ASFM document name as bare character string or a /regular expression/
my $filename = filename_example; # String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
my $unit = unit_example; # String | unit name as bare character string or a /regular expression/
my $class = class_example; # String | class name as bare character string or a /regular expression/
my $invariant = invariant_example; # String | invariant name as bare character string or a /regular expression/
my $field = field_example; # String | field name as bare character string or a /regular expression/
my $method = method_example; # String | method name as bare character string or a /regular expression/
my $type = type_example; # String | type name as bare character string or a /regular expression/
my $macro = macro_example; # String | macro name as bare character string or a /regular expression/
my $constant = constant_example; # String | constant name as bare character string or a /regular expression/
my $member = member_example; # String | member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getDocArtefacts(dbName => $dbName, key => $key, id => $id, doc => $doc, filename => $filename, unit => $unit, class => $class, invariant => $invariant, field => $field, method => $method, type => $type, macro => $macro, constant => $constant, member => $member, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocApi->getDocArtefacts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = 1234 # Integer | artefact identifier (optional) (default to null)
doc = doc_example # String | ASFM document name as bare character string or a /regular expression/ (optional) (default to null)
filename = filename_example # String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional) (default to null)
unit = unit_example # String | unit name as bare character string or a /regular expression/ (optional) (default to null)
class = class_example # String | class name as bare character string or a /regular expression/ (optional) (default to null)
invariant = invariant_example # String | invariant name as bare character string or a /regular expression/ (optional) (default to null)
field = field_example # String | field name as bare character string or a /regular expression/ (optional) (default to null)
method = method_example # String | method name as bare character string or a /regular expression/ (optional) (default to null)
type = type_example # String | type name as bare character string or a /regular expression/ (optional) (default to null)
macro = macro_example # String | macro name as bare character string or a /regular expression/ (optional) (default to null)
constant = constant_example # String | constant name as bare character string or a /regular expression/ (optional) (default to null)
member = member_example # String | member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/ (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_doc_artefacts(dbName, key, id=id, doc=doc, filename=filename, unit=unit, class=class, invariant=invariant, field=field, method=method, type=type, macro=macro, constant=constant, member=member, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->getDocArtefacts: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = 1234; // Integer
    let doc = doc_example; // String
    let filename = filename_example; // String
    let unit = unit_example; // String
    let class = class_example; // String
    let invariant = invariant_example; // String
    let field = field_example; // String
    let method = method_example; // String
    let type = type_example; // String
    let macro = macro_example; // String
    let constant = constant_example; // String
    let member = member_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = DocApi::Context::default();
    let result = client.getDocArtefacts(dbName, key, id, doc, filename, unit, class, invariant, field, method, type, macro, constant, member, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
Integer
artefact identifier
doc
String
ASFM document name as bare character string or a /regular expression/
filename
String
related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
unit
String
unit name as bare character string or a /regular expression/
class
String
class name as bare character string or a /regular expression/
invariant
String
invariant name as bare character string or a /regular expression/
field
String
field name as bare character string or a /regular expression/
method
String
method name as bare character string or a /regular expression/
type
String
type name as bare character string or a /regular expression/
macro
String
macro name as bare character string or a /regular expression/
constant
String
constant name as bare character string or a /regular expression/
member
String
member name (either invariant, field, method, type, macro, or constant name) as bare character string or a /regular expression/
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getDocs

Get ASFM documents from the database


/doc/asfm/docs/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/asfm/docs/{dbName}?doc=doc_example&filename=filename_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String doc = doc_example; // String | ASFM document name as a bare character string or a /regular expression/
        String filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmAsfm] result = apiInstance.getDocs(dbName, key, doc, filename, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String doc = doc_example; // String | ASFM document name as a bare character string or a /regular expression/
        String filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmAsfm] result = apiInstance.getDocs(dbName, key, doc, filename, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *doc = doc_example; // ASFM document name as a bare character string or a /regular expression/ (optional) (default to null)
String *filename = filename_example; // related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getDocsWith:dbName
    key:key
    doc:doc
    filename:filename
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmAsfm] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'doc': doc_example, // {String} ASFM document name as a bare character string or a /regular expression/
  'filename': filename_example, // {String} related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var doc = doc_example;  // String | ASFM document name as a bare character string or a /regular expression/ (optional)  (default to null)
            var filename = filename_example;  // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmAsfm] result = apiInstance.getDocs(dbName, key, doc, filename, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.getDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$doc = doc_example; // String | ASFM document name as a bare character string or a /regular expression/
$filename = filename_example; // String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getDocs($dbName, $key, $doc, $filename, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->getDocs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $doc = doc_example; # String | ASFM document name as a bare character string or a /regular expression/
my $filename = filename_example; # String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getDocs(dbName => $dbName, key => $key, doc => $doc, filename => $filename, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocApi->getDocs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
doc = doc_example # String | ASFM document name as a bare character string or a /regular expression/ (optional) (default to null)
filename = filename_example # String | related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/ (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_docs(dbName, key, doc=doc, filename=filename, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->getDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let doc = doc_example; // String
    let filename = filename_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = DocApi::Context::default();
    let result = client.getDocs(dbName, key, doc, filename, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
doc
String
ASFM document name as a bare character string or a /regular expression/
filename
String
related documentation filename (e.g. .docx file) as a bare character string or a /regular expression/
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGraphicalDocs

Get GSL documents from the database


/doc/gsl/docs/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/gsl/docs/{dbName}?class=class_example&object=object_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String class = class_example; // String | GSL class name
        String object = object_example; // String | GSL object name
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getGraphicalDocs(dbName, key, class, object, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getGraphicalDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String class = class_example; // String | GSL class name
        String object = object_example; // String | GSL object name
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[Object] result = apiInstance.getGraphicalDocs(dbName, key, class, object, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getGraphicalDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *class = class_example; // GSL class name (optional) (default to null)
String *object = object_example; // GSL object name (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getGraphicalDocsWith:dbName
    key:key
    class:class
    object:object
    skip:skip
    limit:limit
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'class': class_example, // {String} GSL class name
  'object': object_example, // {String} GSL object name
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var class = class_example;  // String | GSL class name (optional)  (default to null)
            var object = object_example;  // String | GSL object name (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[Object] result = apiInstance.getGraphicalDocs(dbName, key, class, object, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.getGraphicalDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$class = class_example; // String | GSL class name
$object = object_example; // String | GSL object name
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getGraphicalDocs($dbName, $key, $class, $object, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->getGraphicalDocs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $class = class_example; # String | GSL class name
my $object = object_example; # String | GSL object name
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getGraphicalDocs(dbName => $dbName, key => $key, class => $class, object => $object, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocApi->getGraphicalDocs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
class = class_example # String | GSL class name (optional) (default to null)
object = object_example # String | GSL object name (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_graphical_docs(dbName, key, class=class, object=object, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->getGraphicalDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let class = class_example; // String
    let object = object_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = DocApi::Context::default();
    let result = client.getGraphicalDocs(dbName, key, class, object, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
class
String
GSL class name
object
String
GSL object name
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getRawDoc

Get a single Documentation file from the database


/doc/rawdoc/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/rawdoc/{dbName}/{filename}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Documentation filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getRawDoc(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getRawDoc");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Documentation filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getRawDoc(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getRawDoc");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Documentation filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getRawDocWith:dbName
    filename:filename
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Documentation filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Documentation filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmFile result = apiInstance.getRawDoc(dbName, filename, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.getRawDoc: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Documentation filename
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getRawDoc($dbName, $filename, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->getRawDoc: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Documentation filename
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getRawDoc(dbName => $dbName, filename => $filename, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocApi->getRawDoc: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Documentation filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_raw_doc(dbName, filename, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->getRawDoc: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = DocApi::Context::default();
    let result = client.getRawDoc(dbName, filename, key, abbrev, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Documentation filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getRawDocs

Get all Documentation files from the database


/doc/rawdoc/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/doc/rawdoc/{dbName}?abbrev=true&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getRawDocs(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getRawDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getRawDocs(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#getRawDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getRawDocsWith:dbName
    key:key
    abbrev:abbrev
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmFile] result = apiInstance.getRawDocs(dbName, key, abbrev, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.getRawDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getRawDocs($dbName, $key, $abbrev, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocApi->getRawDocs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DocApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getRawDocs(dbName => $dbName, key => $key, abbrev => $abbrev, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocApi->getRawDocs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_raw_docs(dbName, key, abbrev=abbrev, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->getRawDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = DocApi::Context::default();
    let result = client.getRawDocs(dbName, key, abbrev, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postDocs

Insert some ASFM documents (which are not yet present) into the database


/doc/asfm/docs/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/doc/asfm/docs/{dbName}" \
 -d '{
  "name" : "name",
  "units" : [ {
    "classes" : [ {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    }, {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    } ],
    "name" : "name",
    "id" : 0
  }, {
    "classes" : [ {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    }, {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    } ],
    "name" : "name",
    "id" : 0
  } ],
  "type" : "type",
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAsfm] body = ; // array[PkmAsfm] | 

        try {
            'String' result = apiInstance.postDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#postDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAsfm] body = ; // array[PkmAsfm] | 

        try {
            'String' result = apiInstance.postDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#postDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmAsfm] *body = ; // 

[apiInstance postDocsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmAsfm]} 

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmAsfm](); // array[PkmAsfm] | 

            try {
                'String' result = apiInstance.postDocs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.postDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmAsfm] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmAsfm]->new()]; # array[PkmAsfm] | 

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

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmAsfm] | 

try:
    api_response = api_instance.post_docs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->postDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmAsfm]

    let mut context = DocApi::Context::default();
    let result = client.postDocs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

ASFM documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postGraphicalDocs

Insert some GSL documents (which are not yet present) into the database


/doc/gsl/docs/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/doc/gsl/docs/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            'String' result = apiInstance.postGraphicalDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#postGraphicalDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            'String' result = apiInstance.postGraphicalDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#postGraphicalDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[Object] *body = ; // 

[apiInstance postGraphicalDocsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[Object]} 

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[Object](); // array[Object] | 

            try {
                'String' result = apiInstance.postGraphicalDocs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.postGraphicalDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[Object] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[Object]->new()]; # array[Object] | 

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

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[Object] | 

try:
    api_response = api_instance.post_graphical_docs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->postGraphicalDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[Object]

    let mut context = DocApi::Context::default();
    let result = client.postGraphicalDocs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

GSL documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postRawDocs

Insert some Documentation files (which are not yet present) into the database


/doc/rawdoc/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/doc/rawdoc/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postRawDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#postRawDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postRawDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#postRawDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance postRawDocsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                'String' result = apiInstance.postRawDocs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.postRawDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

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

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_response = api_instance.post_raw_docs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->postRawDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = DocApi::Context::default();
    let result = client.postRawDocs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Documentation files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putDocs

Insert (if not yet present) or update (if already present) some ASFM documents into the database


/doc/asfm/docs/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/doc/asfm/docs/{dbName}" \
 -d '{
  "name" : "name",
  "units" : [ {
    "classes" : [ {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    }, {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    } ],
    "name" : "name",
    "id" : 0
  }, {
    "classes" : [ {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    }, {
      "parent" : 1,
      "types" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "macros" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "methods" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "name" : "name",
      "doc" : "doc",
      "id" : 6,
      "constants" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "fields" : [ {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      }, {
        "parent" : 5,
        "name" : "name",
        "doc" : "doc",
        "id" : 5
      } ],
      "invariants" : [ "invariants", "invariants" ]
    } ],
    "name" : "name",
    "id" : 0
  } ],
  "type" : "type",
  "sourceFile" : "sourceFile"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAsfm] body = ; // array[PkmAsfm] | 

        try {
            'String' result = apiInstance.putDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#putDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmAsfm] body = ; // array[PkmAsfm] | 

        try {
            'String' result = apiInstance.putDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#putDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmAsfm] *body = ; // 

[apiInstance putDocsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmAsfm]} 

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmAsfm](); // array[PkmAsfm] | 

            try {
                'String' result = apiInstance.putDocs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.putDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmAsfm] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmAsfm]->new()]; # array[PkmAsfm] | 

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

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmAsfm] | 

try:
    api_response = api_instance.put_docs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->putDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmAsfm]

    let mut context = DocApi::Context::default();
    let result = client.putDocs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

ASFM documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putGraphicalDocs

Insert (if not yet present) or update (if already present) some GSL documents into the database


/doc/gsl/docs/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/doc/gsl/docs/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            'String' result = apiInstance.putGraphicalDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#putGraphicalDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[Object] body = ; // array[Object] | 

        try {
            'String' result = apiInstance.putGraphicalDocs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#putGraphicalDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[Object] *body = ; // 

[apiInstance putGraphicalDocsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[Object]} 

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[Object](); // array[Object] | 

            try {
                'String' result = apiInstance.putGraphicalDocs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.putGraphicalDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[Object] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[Object]->new()]; # array[Object] | 

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

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[Object] | 

try:
    api_response = api_instance.put_graphical_docs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocApi->putGraphicalDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[Object]

    let mut context = DocApi::Context::default();
    let result = client.putGraphicalDocs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

GSL documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putRawDocs

Insert (if not yet present) or update (if already present) some Documentation files into the database


/doc/rawdoc/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/doc/rawdoc/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DocApi;

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

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

        // Create an instance of the API class
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putRawDocs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#putRawDocs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DocApi;

public class DocApiExample {
    public static void main(String[] args) {
        DocApi apiInstance = new DocApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putRawDocs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocApi#putRawDocs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DocApi *apiInstance = [[DocApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance putRawDocsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.DocApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

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

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

            // Create an instance of the API class
            var apiInstance = new DocApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                apiInstance.putRawDocs(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling DocApi.putRawDocs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DocApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DocApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    $api_instance->putRawDocs(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling DocApi->putRawDocs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DocApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_instance.put_raw_docs(dbName, key, body)
except ApiException as e:
    print("Exception when calling DocApi->putRawDocs: %s\n" % e)
extern crate DocApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = DocApi::Context::default();
    let result = client.putRawDocs(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Documentation files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

ExecutableBinary

deleteExecutableBinaries

Delete all Executable Binary files present in the database together with documents which originate from these Executable Binary files


/bin/executable/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/bin/executable/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExecutableBinaryApi;

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

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

        // Create an instance of the API class
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteExecutableBinaries(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#deleteExecutableBinaries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ExecutableBinaryApi;

public class ExecutableBinaryApiExample {
    public static void main(String[] args) {
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteExecutableBinaries(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#deleteExecutableBinaries");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ExecutableBinaryApi *apiInstance = [[ExecutableBinaryApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteExecutableBinariesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ExecutableBinaryApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new ExecutableBinaryApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExecutableBinaryApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExecutableBinaryApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.ExecutableBinaryApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_executable_binaries(dbName, key)
except ApiException as e:
    print("Exception when calling ExecutableBinaryApi->deleteExecutableBinaries: %s\n" % e)
extern crate ExecutableBinaryApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = ExecutableBinaryApi::Context::default();
    let result = client.deleteExecutableBinaries(dbName, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteExecutableBinary

delete a Executable Binary file from the database


/bin/executable/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/bin/executable/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExecutableBinaryApi;

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

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

        // Create an instance of the API class
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Executable Binary filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteExecutableBinary(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#deleteExecutableBinary");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ExecutableBinaryApi;

public class ExecutableBinaryApiExample {
    public static void main(String[] args) {
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Executable Binary filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteExecutableBinary(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#deleteExecutableBinary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ExecutableBinaryApi *apiInstance = [[ExecutableBinaryApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Executable Binary filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteExecutableBinaryWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ExecutableBinaryApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Executable Binary filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new ExecutableBinaryApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Executable Binary filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteExecutableBinary(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExecutableBinaryApi.deleteExecutableBinary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExecutableBinaryApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Executable Binary filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExecutableBinaryApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Executable Binary filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteExecutableBinary(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling ExecutableBinaryApi->deleteExecutableBinary: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ExecutableBinaryApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Executable Binary filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_executable_binary(dbName, filename, key)
except ApiException as e:
    print("Exception when calling ExecutableBinaryApi->deleteExecutableBinary: %s\n" % e)
extern crate ExecutableBinaryApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = ExecutableBinaryApi::Context::default();
    let result = client.deleteExecutableBinary(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Executable Binary filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getExecutableBinaries

Get all Executable Binary files from the database


/bin/executable/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/bin/executable/{dbName}?abbrev=true&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExecutableBinaryApi;

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

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

        // Create an instance of the API class
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getExecutableBinaries(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#getExecutableBinaries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ExecutableBinaryApi;

public class ExecutableBinaryApiExample {
    public static void main(String[] args) {
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getExecutableBinaries(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#getExecutableBinaries");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ExecutableBinaryApi *apiInstance = [[ExecutableBinaryApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getExecutableBinariesWith:dbName
    key:key
    abbrev:abbrev
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ExecutableBinaryApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new ExecutableBinaryApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmFile] result = apiInstance.getExecutableBinaries(dbName, key, abbrev, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExecutableBinaryApi.getExecutableBinaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExecutableBinaryApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getExecutableBinaries($dbName, $key, $abbrev, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExecutableBinaryApi->getExecutableBinaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExecutableBinaryApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExecutableBinaryApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getExecutableBinaries(dbName => $dbName, key => $key, abbrev => $abbrev, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExecutableBinaryApi->getExecutableBinaries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ExecutableBinaryApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_executable_binaries(dbName, key, abbrev=abbrev, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExecutableBinaryApi->getExecutableBinaries: %s\n" % e)
extern crate ExecutableBinaryApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = ExecutableBinaryApi::Context::default();
    let result = client.getExecutableBinaries(dbName, key, abbrev, skip, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getExecutableBinary

Get a single Executable Binary file from the database


/bin/executable/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/bin/executable/{dbName}/{filename}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExecutableBinaryApi;

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

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

        // Create an instance of the API class
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Executable Binary filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getExecutableBinary(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#getExecutableBinary");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ExecutableBinaryApi;

public class ExecutableBinaryApiExample {
    public static void main(String[] args) {
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | Executable Binary filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getExecutableBinary(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#getExecutableBinary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ExecutableBinaryApi *apiInstance = [[ExecutableBinaryApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // Executable Binary filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getExecutableBinaryWith:dbName
    filename:filename
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ExecutableBinaryApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} Executable Binary filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new ExecutableBinaryApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | Executable Binary filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmFile result = apiInstance.getExecutableBinary(dbName, filename, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExecutableBinaryApi.getExecutableBinary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExecutableBinaryApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | Executable Binary filename
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getExecutableBinary($dbName, $filename, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExecutableBinaryApi->getExecutableBinary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ExecutableBinaryApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExecutableBinaryApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | Executable Binary filename
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getExecutableBinary(dbName => $dbName, filename => $filename, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExecutableBinaryApi->getExecutableBinary: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ExecutableBinaryApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | Executable Binary filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_executable_binary(dbName, filename, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExecutableBinaryApi->getExecutableBinary: %s\n" % e)
extern crate ExecutableBinaryApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = ExecutableBinaryApi::Context::default();
    let result = client.getExecutableBinary(dbName, filename, key, abbrev, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
Executable Binary filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postExecutableBinaries

Insert some Executable Binary files (which are not yet present) into the database


/bin/executable/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/bin/executable/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExecutableBinaryApi;

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

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

        // Create an instance of the API class
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postExecutableBinaries(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#postExecutableBinaries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ExecutableBinaryApi;

public class ExecutableBinaryApiExample {
    public static void main(String[] args) {
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postExecutableBinaries(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#postExecutableBinaries");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ExecutableBinaryApi *apiInstance = [[ExecutableBinaryApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; //  (optional)

[apiInstance postExecutableBinariesWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ExecutableBinaryApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'body':  // {array[PkmFile]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ExecutableBinaryApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] |  (optional) 

            try {
                'String' result = apiInstance.postExecutableBinaries(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExecutableBinaryApi.postExecutableBinaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExecutableBinaryApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExecutableBinaryApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

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

# Create an instance of the API class
api_instance = openapi_client.ExecutableBinaryApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] |  (optional)

try:
    api_response = api_instance.post_executable_binaries(dbName, key, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExecutableBinaryApi->postExecutableBinaries: %s\n" % e)
extern crate ExecutableBinaryApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = ExecutableBinaryApi::Context::default();
    let result = client.postExecutableBinaries(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body

Executable Binary files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putExecutableBinaries

Insert (if not yet present) or update (if already present) some Executable Binary files into the database


/bin/executable/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/bin/executable/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ExecutableBinaryApi;

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

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

        // Create an instance of the API class
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putExecutableBinaries(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#putExecutableBinaries");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ExecutableBinaryApi;

public class ExecutableBinaryApiExample {
    public static void main(String[] args) {
        ExecutableBinaryApi apiInstance = new ExecutableBinaryApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putExecutableBinaries(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExecutableBinaryApi#putExecutableBinaries");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ExecutableBinaryApi *apiInstance = [[ExecutableBinaryApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; //  (optional)

[apiInstance putExecutableBinariesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ExecutableBinaryApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'body':  // {array[PkmFile]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ExecutableBinaryApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] |  (optional) 

            try {
                apiInstance.putExecutableBinaries(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling ExecutableBinaryApi.putExecutableBinaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ExecutableBinaryApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ExecutableBinaryApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    $api_instance->putExecutableBinaries(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling ExecutableBinaryApi->putExecutableBinaries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ExecutableBinaryApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] |  (optional)

try:
    api_instance.put_executable_binaries(dbName, key, body=body)
except ApiException as e:
    print("Exception when calling ExecutableBinaryApi->putExecutableBinaries: %s\n" % e)
extern crate ExecutableBinaryApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = ExecutableBinaryApi::Context::default();
    let result = client.putExecutableBinaries(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body

Executable Binary files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Files

deleteFile

delete a file from the database


/files/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/files/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

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

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM

        try {
            PkmFile result = apiInstance.deleteFile(dbName, filename, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#deleteFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM

        try {
            PkmFile result = apiInstance.deleteFile(dbName, filename, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#deleteFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteFileWith:dbName
    filename:filename
    key:key
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.FilesApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmFile result = apiInstance.deleteFile(dbName, filename, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.deleteFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | filename
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | filename
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.delete_file(dbName, filename, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->deleteFile: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = FilesApi::Context::default();
    let result = client.deleteFile(dbName, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getFile

Get a file from the database


/files/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/files/{dbName}/{filename}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

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

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getFile(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getFile(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getFileWith:dbName
    filename:filename
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.FilesApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
};

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

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

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmFile result = apiInstance.getFile(dbName, filename, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.getFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | filename
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getFile($dbName, $filename, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilesApi->getFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | filename
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getFile(dbName => $dbName, filename => $filename, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilesApi->getFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_file(dbName, filename, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->getFile: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = FilesApi::Context::default();
    let result = client.getFile(dbName, filename, key, abbrev, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getFiles

Get files from the database


/files/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/files/{dbName}?abbrev=true&skip=56&limit=56&type=type_example&gitWorkingTree=gitWorkingTree_example&gitDirty=true&gitUnmerged=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

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

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        String type = type_example; // String | type of file
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        Boolean gitDirty = true; // Boolean | A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree.
        Boolean gitUnmerged = true; // Boolean | A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree.

        try {
            array[PkmFile] result = apiInstance.getFiles(dbName, key, abbrev, skip, limit, type, gitWorkingTree, gitDirty, gitUnmerged);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
        String type = type_example; // String | type of file
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        Boolean gitDirty = true; // Boolean | A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree.
        Boolean gitUnmerged = true; // Boolean | A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree.

        try {
            array[PkmFile] result = apiInstance.getFiles(dbName, key, abbrev, skip, limit, type, gitWorkingTree, gitDirty, gitUnmerged);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
String *type = type_example; // type of file (optional) (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (optional) (default to null)
Boolean *gitDirty = true; // A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree. (optional) (default to null)
Boolean *gitUnmerged = true; // A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree. (optional) (default to null)

[apiInstance getFilesWith:dbName
    key:key
    abbrev:abbrev
    skip:skip
    limit:limit
    type:type
    gitWorkingTree:gitWorkingTree
    gitDirty:gitDirty
    gitUnmerged:gitUnmerged
              completionHandler: ^(array[PkmFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.FilesApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56, // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
  'type': type_example, // {String} type of file
  'gitWorkingTree': gitWorkingTree_example, // {String} Git working tree
  'gitDirty': true, // {Boolean} A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree.
  'gitUnmerged': true // {Boolean} A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree.
};

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

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

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)
            var type = type_example;  // String | type of file (optional)  (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (optional)  (default to null)
            var gitDirty = true;  // Boolean | A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree. (optional)  (default to null)
            var gitUnmerged = true;  // Boolean | A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree. (optional)  (default to null)

            try {
                array[PkmFile] result = apiInstance.getFiles(dbName, key, abbrev, skip, limit, type, gitWorkingTree, gitDirty, gitUnmerged);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.getFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
$type = type_example; // String | type of file
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$gitDirty = true; // Boolean | A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree.
$gitUnmerged = true; // Boolean | A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree.

try {
    $result = $api_instance->getFiles($dbName, $key, $abbrev, $skip, $limit, $type, $gitWorkingTree, $gitDirty, $gitUnmerged);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilesApi->getFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FilesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint
my $type = type_example; # String | type of file
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $gitDirty = true; # Boolean | A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree.
my $gitUnmerged = true; # Boolean | A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree.

eval {
    my $result = $api_instance->getFiles(dbName => $dbName, key => $key, abbrev => $abbrev, skip => $skip, limit => $limit, type => $type, gitWorkingTree => $gitWorkingTree, gitDirty => $gitDirty, gitUnmerged => $gitUnmerged);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilesApi->getFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)
type = type_example # String | type of file (optional) (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (optional) (default to null)
gitDirty = true # Boolean | A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree. (optional) (default to null)
gitUnmerged = true # Boolean | A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree. (optional) (default to null)

try:
    api_response = api_instance.get_files(dbName, key, abbrev=abbrev, skip=skip, limit=limit, type=type, gitWorkingTree=gitWorkingTree, gitDirty=gitDirty, gitUnmerged=gitUnmerged)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->getFiles: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let skip = 56; // Integer
    let limit = 56; // Integer
    let type = type_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let gitDirty = true; // Boolean
    let gitUnmerged = true; // Boolean

    let mut context = FilesApi::Context::default();
    let result = client.getFiles(dbName, key, abbrev, skip, limit, type, gitWorkingTree, gitDirty, gitUnmerged, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint
type
String
type of file
gitWorkingTree
String
Git working tree
gitDirty
Boolean
A dirty flag intended for the PKM Git service to indicate that a PKM File has been modified since the last synchronization with the Git working tree.
gitUnmerged
Boolean
A flag intended for the user provided by the PKM Git service to indicate that a PKM File is unmerged (merge conflict ?) since the last synchronization with the Git working tree.

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postFiles

Insert some files (which are not yet present) into the database. The related documents (source code AST, comments and annotations, etc. ) which originate from the files are invalidated.


/files/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/files/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

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

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postFiles(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#postFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postFiles(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#postFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance postFilesWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.FilesApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

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

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

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                'String' result = apiInstance.postFiles(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.postFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

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

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_response = api_instance.post_files(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->postFiles: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = FilesApi::Context::default();
    let result = client.postFiles(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putFiles

Insert (if not yet present) or update (if already present) some files into the database. The related documents (source code AST, comments and annotations, etc. ) which originate from the files are invalidated.


/files/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/files/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FilesApi;

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

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

        // Create an instance of the API class
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putFiles(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#putFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FilesApi;

public class FilesApiExample {
    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putFiles(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#putFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FilesApi *apiInstance = [[FilesApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance putFilesWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.FilesApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

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

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

            // Create an instance of the API class
            var apiInstance = new FilesApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                apiInstance.putFiles(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling FilesApi.putFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FilesApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FilesApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    $api_instance->putFiles(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling FilesApi->putFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FilesApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_instance.put_files(dbName, key, body)
except ApiException as e:
    print("Exception when calling FilesApi->putFiles: %s\n" % e)
extern crate FilesApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = FilesApi::Context::default();
    let result = client.putFiles(dbName, key, body, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Fini

postFiniPkm

Finalize PKM. Drop Role 'user' in users database, then drop all users in users database.


/fini

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/fini" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FiniApi;

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

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

        // Create an instance of the API class
        FiniApi apiInstance = new FiniApi();
        InlineObject4 body = ; // InlineObject4 | 

        try {
            apiInstance.postFiniPkm(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FiniApi#postFiniPkm");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FiniApi;

public class FiniApiExample {
    public static void main(String[] args) {
        FiniApi apiInstance = new FiniApi();
        InlineObject4 body = ; // InlineObject4 | 

        try {
            apiInstance.postFiniPkm(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FiniApi#postFiniPkm");
            e.printStackTrace();
        }
    }
}


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

[apiInstance postFiniPkmWith:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.FiniApi()
var body = ; // {InlineObject4} 

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

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

            // Create an instance of the API class
            var apiInstance = new FiniApi();
            var body = new InlineObject4(); // InlineObject4 | 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FiniApi();
$body = ; // InlineObject4 | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FiniApi->new();
my $body = WWW::OPenAPIClient::Object::InlineObject4->new(); # InlineObject4 | 

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

# Create an instance of the API class
api_instance = openapi_client.FiniApi()
body =  # InlineObject4 | 

try:
    api_instance.post_fini_pkm(body)
except ApiException as e:
    print("Exception when calling FiniApi->postFiniPkm: %s\n" % e)
extern crate FiniApi;

pub fn main() {
    let body = ; // InlineObject4

    let mut context = FiniApi::Context::default();
    let result = client.postFiniPkm(body, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Git

deleteGitFile

delete a file in the Git working tree associated to the database.


/git/files/{dbName}/{gitWorkingTree}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/files/{dbName}/{gitWorkingTree}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

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

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

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteGitFile(dbName, gitWorkingTree, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteGitFile(dbName, gitWorkingTree, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *filename = filename_example; // filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteGitFileWith:dbName
    gitWorkingTree:gitWorkingTree
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var filename = filename_example; // {String} filename
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var filename = filename_example;  // String | filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteGitFile(dbName, gitWorkingTree, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.deleteGitFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$filename = filename_example; // String | filename
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteGitFile($dbName, $gitWorkingTree, $filename, $key);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->deleteGitFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $filename = filename_example; # String | filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteGitFile(dbName => $dbName, gitWorkingTree => $gitWorkingTree, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling GitApi->deleteGitFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
filename = filename_example # String | filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_git_file(dbName, gitWorkingTree, filename, key)
except ApiException as e:
    print("Exception when calling GitApi->deleteGitFile: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = GitApi::Context::default();
    let result = client.deleteGitFile(dbName, gitWorkingTree, filename, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
filename*
String
filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteGitFiles

delete files in the Git working tree associated to the database.


/git/files/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/files/{dbName}/{gitWorkingTree}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

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

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

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteGitFiles(dbName, gitWorkingTree, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteGitFiles(dbName, gitWorkingTree, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteGitFilesWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteGitFiles(dbName, gitWorkingTree, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.deleteGitFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteGitFiles(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key);
};
if ($@) {
    warn "Exception when calling GitApi->deleteGitFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_git_files(dbName, gitWorkingTree, key)
except ApiException as e:
    print("Exception when calling GitApi->deleteGitFiles: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String

    let mut context = GitApi::Context::default();
    let result = client.deleteGitFiles(dbName, gitWorkingTree, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteGitWorkingTree

delete a Git Working Tree document from the database


/git/working_trees/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/working_trees/{dbName}/{gitWorkingTree}?dontDeletePkmFiles=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

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

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

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        Boolean dontDeletePkmFiles = true; // Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

        try {
            apiInstance.deleteGitWorkingTree(dbName, gitWorkingTree, key, dontDeletePkmFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitWorkingTree");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        Boolean dontDeletePkmFiles = true; // Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

        try {
            apiInstance.deleteGitWorkingTree(dbName, gitWorkingTree, key, dontDeletePkmFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitWorkingTree");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *dontDeletePkmFiles = true; // a flag to control deletion of files in the PKM together with the Git working trees. (optional) (default to false)

[apiInstance deleteGitWorkingTreeWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
    dontDeletePkmFiles:dontDeletePkmFiles
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM
var opts = {
  'dontDeletePkmFiles': true // {Boolean} a flag to control deletion of files in the PKM together with the Git working trees.
};

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

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

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var dontDeletePkmFiles = true;  // Boolean | a flag to control deletion of files in the PKM together with the Git working trees. (optional)  (default to false)

            try {
                apiInstance.deleteGitWorkingTree(dbName, gitWorkingTree, key, dontDeletePkmFiles);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.deleteGitWorkingTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM
$dontDeletePkmFiles = true; // Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

try {
    $api_instance->deleteGitWorkingTree($dbName, $gitWorkingTree, $key, $dontDeletePkmFiles);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->deleteGitWorkingTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM
my $dontDeletePkmFiles = true; # Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

eval {
    $api_instance->deleteGitWorkingTree(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key, dontDeletePkmFiles => $dontDeletePkmFiles);
};
if ($@) {
    warn "Exception when calling GitApi->deleteGitWorkingTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)
dontDeletePkmFiles = true # Boolean | a flag to control deletion of files in the PKM together with the Git working trees. (optional) (default to false)

try:
    api_instance.delete_git_working_tree(dbName, gitWorkingTree, key, dontDeletePkmFiles=dontDeletePkmFiles)
except ApiException as e:
    print("Exception when calling GitApi->deleteGitWorkingTree: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String
    let dontDeletePkmFiles = true; // Boolean

    let mut context = GitApi::Context::default();
    let result = client.deleteGitWorkingTree(dbName, gitWorkingTree, key, dontDeletePkmFiles, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
dontDeletePkmFiles
Boolean
a flag to control deletion of files in the PKM together with the Git working trees.

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteGitWorkingTrees

Delete all Git Working Tree documents present in the database


/git/working_trees/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/working_trees/{dbName}?dontDeletePkmFiles=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

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

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

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean dontDeletePkmFiles = true; // Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

        try {
            apiInstance.deleteGitWorkingTrees(dbName, key, dontDeletePkmFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitWorkingTrees");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean dontDeletePkmFiles = true; // Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

        try {
            apiInstance.deleteGitWorkingTrees(dbName, key, dontDeletePkmFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#deleteGitWorkingTrees");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *dontDeletePkmFiles = true; // a flag to control deletion of files in the PKM together with the Git working trees. (optional) (default to false)

[apiInstance deleteGitWorkingTreesWith:dbName
    key:key
    dontDeletePkmFiles:dontDeletePkmFiles
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'dontDeletePkmFiles': true // {Boolean} a flag to control deletion of files in the PKM together with the Git working trees.
};

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

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

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var dontDeletePkmFiles = true;  // Boolean | a flag to control deletion of files in the PKM together with the Git working trees. (optional)  (default to false)

            try {
                apiInstance.deleteGitWorkingTrees(dbName, key, dontDeletePkmFiles);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.deleteGitWorkingTrees: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$dontDeletePkmFiles = true; // Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $dontDeletePkmFiles = true; # Boolean | a flag to control deletion of files in the PKM together with the Git working trees.

eval {
    $api_instance->deleteGitWorkingTrees(dbName => $dbName, key => $key, dontDeletePkmFiles => $dontDeletePkmFiles);
};
if ($@) {
    warn "Exception when calling GitApi->deleteGitWorkingTrees: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
dontDeletePkmFiles = true # Boolean | a flag to control deletion of files in the PKM together with the Git working trees. (optional) (default to false)

try:
    api_instance.delete_git_working_trees(dbName, key, dontDeletePkmFiles=dontDeletePkmFiles)
except ApiException as e:
    print("Exception when calling GitApi->deleteGitWorkingTrees: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let dontDeletePkmFiles = true; // Boolean

    let mut context = GitApi::Context::default();
    let result = client.deleteGitWorkingTrees(dbName, key, dontDeletePkmFiles, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
dontDeletePkmFiles
Boolean
a flag to control deletion of files in the PKM together with the Git working trees.

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGitConfig

Get the Git configuration file of the Git directory (usually .git/config) associated to a Git working tree


/git/config/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/config/{dbName}/{gitWorkingTree}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

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

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

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM

        try {
            inline_response_200 result = apiInstance.getGitConfig(dbName, gitWorkingTree, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM

        try {
            inline_response_200 result = apiInstance.getGitConfig(dbName, gitWorkingTree, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getGitConfigWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
              completionHandler: ^(inline_response_200 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM

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

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

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                inline_response_200 result = apiInstance.getGitConfig(dbName, gitWorkingTree, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.getGitConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM

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

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_git_config(dbName, gitWorkingTree, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->getGitConfig: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String

    let mut context = GitApi::Context::default();
    let result = client.getGitConfig(dbName, gitWorkingTree, key, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGitFile

get a file in the Git working tree associated to the database.


/git/files/{dbName}/{gitWorkingTree}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/files/{dbName}/{gitWorkingTree}/{filename}?abbrev=true&encoding=encoding_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

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

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

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        String encoding = encoding_example; // String | text encoding

        try {
            PkmFile result = apiInstance.getGitFile(dbName, gitWorkingTree, filename, key, abbrev, encoding);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitFile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        String encoding = encoding_example; // String | text encoding

        try {
            PkmFile result = apiInstance.getGitFile(dbName, gitWorkingTree, filename, key, abbrev, encoding);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *filename = filename_example; // filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
String *encoding = encoding_example; // text encoding (optional) (default to utf8)

[apiInstance getGitFileWith:dbName
    gitWorkingTree:gitWorkingTree
    filename:filename
    key:key
    abbrev:abbrev
    encoding:encoding
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var filename = filename_example; // {String} filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'encoding': encoding_example // {String} text encoding
};

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

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

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var filename = filename_example;  // String | filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var encoding = encoding_example;  // String | text encoding (optional)  (default to utf8)

            try {
                PkmFile result = apiInstance.getGitFile(dbName, gitWorkingTree, filename, key, abbrev, encoding);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.getGitFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$filename = filename_example; // String | filename
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$encoding = encoding_example; // String | text encoding

try {
    $result = $api_instance->getGitFile($dbName, $gitWorkingTree, $filename, $key, $abbrev, $encoding);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->getGitFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $filename = filename_example; # String | filename
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $encoding = encoding_example; # String | text encoding

eval {
    my $result = $api_instance->getGitFile(dbName => $dbName, gitWorkingTree => $gitWorkingTree, filename => $filename, key => $key, abbrev => $abbrev, encoding => $encoding);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->getGitFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
filename = filename_example # String | filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
encoding = encoding_example # String | text encoding (optional) (default to utf8)

try:
    api_response = api_instance.get_git_file(dbName, gitWorkingTree, filename, key, abbrev=abbrev, encoding=encoding)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->getGitFile: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let encoding = encoding_example; // String

    let mut context = GitApi::Context::default();
    let result = client.getGitFile(dbName, gitWorkingTree, filename, key, abbrev, encoding, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
filename*
String
filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
encoding
String
text encoding

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGitFiles

get files in the Git working tree associated to the database.


/git/files/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/files/{dbName}/{gitWorkingTree}?abbrev=true&encoding=encoding_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        String encoding = encoding_example; // String | text encoding

        try {
            array[PkmFile] result = apiInstance.getGitFiles(dbName, gitWorkingTree, key, abbrev, encoding);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        String encoding = encoding_example; // String | text encoding

        try {
            array[PkmFile] result = apiInstance.getGitFiles(dbName, gitWorkingTree, key, abbrev, encoding);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
String *encoding = encoding_example; // text encoding (optional) (default to utf8)

[apiInstance getGitFilesWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
    abbrev:abbrev
    encoding:encoding
              completionHandler: ^(array[PkmFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'encoding': encoding_example // {String} text encoding
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGitFiles(dbName, gitWorkingTree, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGitFilesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var encoding = encoding_example;  // String | text encoding (optional)  (default to utf8)

            try {
                array[PkmFile] result = apiInstance.getGitFiles(dbName, gitWorkingTree, key, abbrev, encoding);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.getGitFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$encoding = encoding_example; // String | text encoding

try {
    $result = $api_instance->getGitFiles($dbName, $gitWorkingTree, $key, $abbrev, $encoding);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->getGitFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $encoding = encoding_example; # String | text encoding

eval {
    my $result = $api_instance->getGitFiles(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key, abbrev => $abbrev, encoding => $encoding);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->getGitFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
encoding = encoding_example # String | text encoding (optional) (default to utf8)

try:
    api_response = api_instance.get_git_files(dbName, gitWorkingTree, key, abbrev=abbrev, encoding=encoding)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->getGitFiles: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let encoding = encoding_example; // String

    let mut context = GitApi::Context::default();
    let result = client.getGitFiles(dbName, gitWorkingTree, key, abbrev, encoding, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
encoding
String
text encoding

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGitJob

Get Git Job. Getting a finished or failed job, unpublish it (it is no longer available))


/git/jobs/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/jobs/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        Integer jobId = 56; // Integer | Job identifier
        String key = key_example; // String | Access key to the PKM

        try {
            GitJob result = apiInstance.getGitJob(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        Integer jobId = 56; // Integer | Job identifier
        String key = key_example; // String | Access key to the PKM

        try {
            GitJob result = apiInstance.getGitJob(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitJob");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
Integer *jobId = 56; // Job identifier (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getGitJobWith:jobId
    key:key
              completionHandler: ^(GitJob output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var jobId = 56; // {Integer} Job identifier
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGitJob(jobId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGitJobExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var jobId = 56;  // Integer | Job identifier (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                GitJob result = apiInstance.getGitJob(jobId, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.getGitJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$jobId = 56; // Integer | Job identifier
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getGitJob($jobId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->getGitJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $jobId = 56; # Integer | Job identifier
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getGitJob(jobId => $jobId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->getGitJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
jobId = 56 # Integer | Job identifier (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_git_job(jobId, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->getGitJob: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let jobId = 56; // Integer
    let key = key_example; // String

    let mut context = GitApi::Context::default();
    let result = client.getGitJob(jobId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer
Job identifier
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGitWorkingTree

Get Git Working Tree documents by Git working tree from the database


/git/working_trees/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/working_trees/{dbName}/{gitWorkingTree}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM

        try {
            PkmGitWorkingTree result = apiInstance.getGitWorkingTree(dbName, gitWorkingTree, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitWorkingTree");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM

        try {
            PkmGitWorkingTree result = apiInstance.getGitWorkingTree(dbName, gitWorkingTree, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitWorkingTree");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getGitWorkingTreeWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
              completionHandler: ^(PkmGitWorkingTree output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGitWorkingTree(dbName, gitWorkingTree, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGitWorkingTreeExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmGitWorkingTree result = apiInstance.getGitWorkingTree(dbName, gitWorkingTree, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.getGitWorkingTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getGitWorkingTree($dbName, $gitWorkingTree, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->getGitWorkingTree: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getGitWorkingTree(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->getGitWorkingTree: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_git_working_tree(dbName, gitWorkingTree, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->getGitWorkingTree: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String

    let mut context = GitApi::Context::default();
    let result = client.getGitWorkingTree(dbName, gitWorkingTree, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getGitWorkingTrees

Get all Git Working Tree documents from the database


/git/working_trees/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/git/working_trees/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmGitWorkingTree] result = apiInstance.getGitWorkingTrees(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitWorkingTrees");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmGitWorkingTree] result = apiInstance.getGitWorkingTrees(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#getGitWorkingTrees");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getGitWorkingTreesWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmGitWorkingTree] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGitWorkingTrees(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGitWorkingTreesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmGitWorkingTree] result = apiInstance.getGitWorkingTrees(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.getGitWorkingTrees: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getGitWorkingTrees($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->getGitWorkingTrees: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getGitWorkingTrees(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->getGitWorkingTrees: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_git_working_trees(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->getGitWorkingTrees: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = GitApi::Context::default();
    let result = client.getGitWorkingTrees(dbName, key, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postGitFiles

post some files in the Git working tree associated to the database.


/git/files/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/git/files/{dbName}/{gitWorkingTree}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postGitFiles(dbName, gitWorkingTree, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#postGitFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postGitFiles(dbName, gitWorkingTree, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#postGitFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance postGitFilesWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postGitFiles(dbName, gitWorkingTree, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postGitFilesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                'String' result = apiInstance.postGitFiles(dbName, gitWorkingTree, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.postGitFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

try {
    $result = $api_instance->postGitFiles($dbName, $gitWorkingTree, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->postGitFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    my $result = $api_instance->postGitFiles(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->postGitFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_response = api_instance.post_git_files(dbName, gitWorkingTree, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->postGitFiles: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = GitApi::Context::default();
    let result = client.postGitFiles(dbName, gitWorkingTree, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postGitRun

Run Git commands


/git/run/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/git/run/{dbName}?asynchronous=true" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        InlineObject body = ; // InlineObject | 
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of Git job

        try {
            GitJob result = apiInstance.postGitRun(dbName, key, body, asynchronous);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#postGitRun");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        InlineObject body = ; // InlineObject | 
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of Git job

        try {
            GitJob result = apiInstance.postGitRun(dbName, key, body, asynchronous);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#postGitRun");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
InlineObject *body = ; // 
Boolean *asynchronous = true; // flag to control asynchronous/synchronous execution of Git job (optional) (default to false)

[apiInstance postGitRunWith:dbName
    key:key
    body:body
    asynchronous:asynchronous
              completionHandler: ^(GitJob output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {InlineObject} 
var opts = {
  'asynchronous': true // {Boolean} flag to control asynchronous/synchronous execution of Git job
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postGitRun(dbName, key, body, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postGitRunExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new InlineObject(); // InlineObject | 
            var asynchronous = true;  // Boolean | flag to control asynchronous/synchronous execution of Git job (optional)  (default to false)

            try {
                GitJob result = apiInstance.postGitRun(dbName, key, body, asynchronous);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.postGitRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // InlineObject | 
$asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of Git job

try {
    $result = $api_instance->postGitRun($dbName, $key, $body, $asynchronous);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->postGitRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::InlineObject->new(); # InlineObject | 
my $asynchronous = true; # Boolean | flag to control asynchronous/synchronous execution of Git job

eval {
    my $result = $api_instance->postGitRun(dbName => $dbName, key => $key, body => $body, asynchronous => $asynchronous);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GitApi->postGitRun: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # InlineObject | 
asynchronous = true # Boolean | flag to control asynchronous/synchronous execution of Git job (optional) (default to false)

try:
    api_response = api_instance.post_git_run(dbName, key, body, asynchronous=asynchronous)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GitApi->postGitRun: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // InlineObject
    let asynchronous = true; // Boolean

    let mut context = GitApi::Context::default();
    let result = client.postGitRun(dbName, key, body, asynchronous, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Query parameters
Name Description
asynchronous
Boolean
flag to control asynchronous/synchronous execution of Git job

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putGitConfig

Update the Git configuration file of the Git directory (usually .git/config) associated to a Git working tree


/git/config/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/git/config/{dbName}/{gitWorkingTree}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        InlineObject1 body = ; // InlineObject1 | 

        try {
            apiInstance.putGitConfig(dbName, gitWorkingTree, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#putGitConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        InlineObject1 body = ; // InlineObject1 | 

        try {
            apiInstance.putGitConfig(dbName, gitWorkingTree, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#putGitConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)
InlineObject1 *body = ; // 

[apiInstance putGitConfigWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM
var body = ; // {InlineObject1} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putGitConfig(dbName, gitWorkingTree, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putGitConfigExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new InlineObject1(); // InlineObject1 | 

            try {
                apiInstance.putGitConfig(dbName, gitWorkingTree, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.putGitConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM
$body = ; // InlineObject1 | 

try {
    $api_instance->putGitConfig($dbName, $gitWorkingTree, $key, $body);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->putGitConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::InlineObject1->new(); # InlineObject1 | 

eval {
    $api_instance->putGitConfig(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling GitApi->putGitConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # InlineObject1 | 

try:
    api_instance.put_git_config(dbName, gitWorkingTree, key, body)
except ApiException as e:
    print("Exception when calling GitApi->putGitConfig: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String
    let body = ; // InlineObject1

    let mut context = GitApi::Context::default();
    let result = client.putGitConfig(dbName, gitWorkingTree, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putGitFiles

put some files in the Git working tree associated to the database.


/git/files/{dbName}/{gitWorkingTree}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/git/files/{dbName}/{gitWorkingTree}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GitApi;

import java.io.File;
import java.util.*;

public class GitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putGitFiles(dbName, gitWorkingTree, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#putGitFiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GitApi;

public class GitApiExample {
    public static void main(String[] args) {
        GitApi apiInstance = new GitApi();
        String dbName = dbName_example; // String | Database name
        String gitWorkingTree = gitWorkingTree_example; // String | Git working tree
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putGitFiles(dbName, gitWorkingTree, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GitApi#putGitFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GitApi *apiInstance = [[GitApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *gitWorkingTree = gitWorkingTree_example; // Git working tree (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance putGitFilesWith:dbName
    gitWorkingTree:gitWorkingTree
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.GitApi()
var dbName = dbName_example; // {String} Database name
var gitWorkingTree = gitWorkingTree_example; // {String} Git working tree
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putGitFiles(dbName, gitWorkingTree, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putGitFilesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new GitApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var gitWorkingTree = gitWorkingTree_example;  // String | Git working tree (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                apiInstance.putGitFiles(dbName, gitWorkingTree, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling GitApi.putGitFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GitApi();
$dbName = dbName_example; // String | Database name
$gitWorkingTree = gitWorkingTree_example; // String | Git working tree
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

try {
    $api_instance->putGitFiles($dbName, $gitWorkingTree, $key, $body);
} catch (Exception $e) {
    echo 'Exception when calling GitApi->putGitFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GitApi->new();
my $dbName = dbName_example; # String | Database name
my $gitWorkingTree = gitWorkingTree_example; # String | Git working tree
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    $api_instance->putGitFiles(dbName => $dbName, gitWorkingTree => $gitWorkingTree, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling GitApi->putGitFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GitApi()
dbName = dbName_example # String | Database name (default to null)
gitWorkingTree = gitWorkingTree_example # String | Git working tree (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_instance.put_git_files(dbName, gitWorkingTree, key, body)
except ApiException as e:
    print("Exception when calling GitApi->putGitFiles: %s\n" % e)
extern crate GitApi;

pub fn main() {
    let dbName = dbName_example; // String
    let gitWorkingTree = gitWorkingTree_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = GitApi::Context::default();
    let result = client.putGitFiles(dbName, gitWorkingTree, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
gitWorkingTree*
String
Git working tree
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

IO

download


/io/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,text/markdown,text/plain,application/json" \
 "http://pkm-api_pkm_1:8080/io/{dbName}/{filename}?key=key_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IOApi;

import java.io.File;
import java.util.*;

public class IOApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IOApi apiInstance = new IOApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM

        try {
            File result = apiInstance.download(dbName, filename, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IOApi#download");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.IOApi;

public class IOApiExample {
    public static void main(String[] args) {
        IOApi apiInstance = new IOApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | filename
        String key = key_example; // String | Access key to the PKM

        try {
            File result = apiInstance.download(dbName, filename, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IOApi#download");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
IOApi *apiInstance = [[IOApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance downloadWith:dbName
    filename:filename
    key:key
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.IOApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} filename
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.download(dbName, filename, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class downloadExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new IOApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                File result = apiInstance.download(dbName, filename, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IOApi.download: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IOApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | filename
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->download($dbName, $filename, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IOApi->download: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IOApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IOApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | filename
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->download(dbName => $dbName, filename => $filename, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IOApi->download: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.IOApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.download(dbName, filename, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IOApi->download: %s\n" % e)
extern crate IOApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = IOApi::Context::default();
    let result = client.download(dbName, filename, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
filename
Required
Query parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Init

postInitPkm

Initialize PKM. Create Role 'user' in users database, then create a PKM administrator in users database.


/init

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/init" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InitApi;

import java.io.File;
import java.util.*;

public class InitApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InitApi apiInstance = new InitApi();
        InlineObject3 body = ; // InlineObject3 | 

        try {
            'String' result = apiInstance.postInitPkm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InitApi#postInitPkm");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InitApi;

public class InitApiExample {
    public static void main(String[] args) {
        InitApi apiInstance = new InitApi();
        InlineObject3 body = ; // InlineObject3 | 

        try {
            'String' result = apiInstance.postInitPkm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InitApi#postInitPkm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InitApi *apiInstance = [[InitApi alloc] init];
InlineObject3 *body = ; // 

[apiInstance postInitPkmWith:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InitApi()
var body = ; // {InlineObject3} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postInitPkm(body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInitPkmExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InitApi();
            var body = new InlineObject3(); // InlineObject3 | 

            try {
                'String' result = apiInstance.postInitPkm(body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InitApi.postInitPkm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InitApi();
$body = ; // InlineObject3 | 

try {
    $result = $api_instance->postInitPkm($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InitApi->postInitPkm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InitApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InitApi->new();
my $body = WWW::OPenAPIClient::Object::InlineObject3->new(); # InlineObject3 | 

eval {
    my $result = $api_instance->postInitPkm(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InitApi->postInitPkm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InitApi()
body =  # InlineObject3 | 

try:
    api_response = api_instance.post_init_pkm(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InitApi->postInitPkm: %s\n" % e)
extern crate InitApi;

pub fn main() {
    let body = ; // InlineObject3

    let mut context = InitApi::Context::default();
    let result = client.postInitPkm(body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Invocations

deleteInvocation

delete a Invocation document from the database


/invocations/{dbName}/{invocationID}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/invocations/{dbName}/{invocationID}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvocationsApi;

import java.io.File;
import java.util.*;

public class InvocationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String invocationID = invocationID_example; // String | Invocation ID
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteInvocation(dbName, invocationID, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#deleteInvocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InvocationsApi;

public class InvocationsApiExample {
    public static void main(String[] args) {
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String invocationID = invocationID_example; // String | Invocation ID
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteInvocation(dbName, invocationID, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#deleteInvocation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InvocationsApi *apiInstance = [[InvocationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *invocationID = invocationID_example; // Invocation ID (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteInvocationWith:dbName
    invocationID:invocationID
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InvocationsApi()
var dbName = dbName_example; // {String} Database name
var invocationID = invocationID_example; // {String} Invocation ID
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteInvocation(dbName, invocationID, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteInvocationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InvocationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var invocationID = invocationID_example;  // String | Invocation ID (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteInvocation(dbName, invocationID, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvocationsApi.deleteInvocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvocationsApi();
$dbName = dbName_example; // String | Database name
$invocationID = invocationID_example; // String | Invocation ID
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteInvocation($dbName, $invocationID, $key);
} catch (Exception $e) {
    echo 'Exception when calling InvocationsApi->deleteInvocation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvocationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvocationsApi->new();
my $dbName = dbName_example; # String | Database name
my $invocationID = invocationID_example; # String | Invocation ID
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteInvocation(dbName => $dbName, invocationID => $invocationID, key => $key);
};
if ($@) {
    warn "Exception when calling InvocationsApi->deleteInvocation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InvocationsApi()
dbName = dbName_example # String | Database name (default to null)
invocationID = invocationID_example # String | Invocation ID (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_invocation(dbName, invocationID, key)
except ApiException as e:
    print("Exception when calling InvocationsApi->deleteInvocation: %s\n" % e)
extern crate InvocationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let invocationID = invocationID_example; // String
    let key = key_example; // String

    let mut context = InvocationsApi::Context::default();
    let result = client.deleteInvocation(dbName, invocationID, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
invocationID*
String
Invocation ID
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteInvocations

Delete all Invocation documents present in the database


/invocations/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/invocations/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvocationsApi;

import java.io.File;
import java.util.*;

public class InvocationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteInvocations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#deleteInvocations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InvocationsApi;

public class InvocationsApiExample {
    public static void main(String[] args) {
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteInvocations(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#deleteInvocations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InvocationsApi *apiInstance = [[InvocationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteInvocationsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InvocationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteInvocations(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteInvocationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InvocationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteInvocations(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvocationsApi.deleteInvocations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvocationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteInvocations($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling InvocationsApi->deleteInvocations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvocationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvocationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteInvocations(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling InvocationsApi->deleteInvocations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InvocationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_invocations(dbName, key)
except ApiException as e:
    print("Exception when calling InvocationsApi->deleteInvocations: %s\n" % e)
extern crate InvocationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = InvocationsApi::Context::default();
    let result = client.deleteInvocations(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getInvocation

Get Invocation documents by Invocation ID from the database


/invocations/{dbName}/{invocationID}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/invocations/{dbName}/{invocationID}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvocationsApi;

import java.io.File;
import java.util.*;

public class InvocationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String invocationID = invocationID_example; // String | Invocation ID
        String key = key_example; // String | Access key to the PKM

        try {
            PkmInvocation result = apiInstance.getInvocation(dbName, invocationID, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#getInvocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InvocationsApi;

public class InvocationsApiExample {
    public static void main(String[] args) {
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String invocationID = invocationID_example; // String | Invocation ID
        String key = key_example; // String | Access key to the PKM

        try {
            PkmInvocation result = apiInstance.getInvocation(dbName, invocationID, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#getInvocation");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InvocationsApi *apiInstance = [[InvocationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *invocationID = invocationID_example; // Invocation ID (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getInvocationWith:dbName
    invocationID:invocationID
    key:key
              completionHandler: ^(PkmInvocation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InvocationsApi()
var dbName = dbName_example; // {String} Database name
var invocationID = invocationID_example; // {String} Invocation ID
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvocation(dbName, invocationID, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvocationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InvocationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var invocationID = invocationID_example;  // String | Invocation ID (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmInvocation result = apiInstance.getInvocation(dbName, invocationID, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvocationsApi.getInvocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvocationsApi();
$dbName = dbName_example; // String | Database name
$invocationID = invocationID_example; // String | Invocation ID
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getInvocation($dbName, $invocationID, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvocationsApi->getInvocation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvocationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvocationsApi->new();
my $dbName = dbName_example; # String | Database name
my $invocationID = invocationID_example; # String | Invocation ID
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getInvocation(dbName => $dbName, invocationID => $invocationID, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvocationsApi->getInvocation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InvocationsApi()
dbName = dbName_example # String | Database name (default to null)
invocationID = invocationID_example # String | Invocation ID (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_invocation(dbName, invocationID, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvocationsApi->getInvocation: %s\n" % e)
extern crate InvocationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let invocationID = invocationID_example; // String
    let key = key_example; // String

    let mut context = InvocationsApi::Context::default();
    let result = client.getInvocation(dbName, invocationID, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
invocationID*
String
Invocation ID
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getInvocations

Get all Invocation documents from the database


/invocations/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/invocations/{dbName}?invocationStatus=invocationStatus_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvocationsApi;

import java.io.File;
import java.util.*;

public class InvocationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String invocationStatus = invocationStatus_example; // String | invocation status
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmInvocation] result = apiInstance.getInvocations(dbName, key, invocationStatus, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#getInvocations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InvocationsApi;

public class InvocationsApiExample {
    public static void main(String[] args) {
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String invocationStatus = invocationStatus_example; // String | invocation status
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmInvocation] result = apiInstance.getInvocations(dbName, key, invocationStatus, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#getInvocations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InvocationsApi *apiInstance = [[InvocationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *invocationStatus = invocationStatus_example; // invocation status (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getInvocationsWith:dbName
    key:key
    invocationStatus:invocationStatus
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmInvocation] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InvocationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'invocationStatus': invocationStatus_example, // {String} invocation status
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvocations(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvocationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InvocationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var invocationStatus = invocationStatus_example;  // String | invocation status (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmInvocation] result = apiInstance.getInvocations(dbName, key, invocationStatus, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvocationsApi.getInvocations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvocationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$invocationStatus = invocationStatus_example; // String | invocation status
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getInvocations($dbName, $key, $invocationStatus, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvocationsApi->getInvocations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvocationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvocationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $invocationStatus = invocationStatus_example; # String | invocation status
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getInvocations(dbName => $dbName, key => $key, invocationStatus => $invocationStatus, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvocationsApi->getInvocations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InvocationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
invocationStatus = invocationStatus_example # String | invocation status (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_invocations(dbName, key, invocationStatus=invocationStatus, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvocationsApi->getInvocations: %s\n" % e)
extern crate InvocationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let invocationStatus = invocationStatus_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = InvocationsApi::Context::default();
    let result = client.getInvocations(dbName, key, invocationStatus, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
invocationStatus
String
invocation status
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postInvocations

Insert some Invocation documents (which are not yet present) into the database


/invocations/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/invocations/{dbName}" \
 -d '{
  "timestampRequest" : "timestampRequest",
  "invocationConfiguration" : "{}",
  "timestampCompleted" : "timestampCompleted",
  "invocationResults" : [ {
    "path" : "path",
    "type" : "type"
  }, {
    "path" : "path",
    "type" : "type"
  } ],
  "timestampStart" : "timestampStart",
  "invocationID" : "invocationID",
  "user" : "user",
  "tool" : "tool",
  "invocationStatus" : "PENDING"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvocationsApi;

import java.io.File;
import java.util.*;

public class InvocationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmInvocation] body = ; // array[PkmInvocation] | 

        try {
            'String' result = apiInstance.postInvocations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#postInvocations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InvocationsApi;

public class InvocationsApiExample {
    public static void main(String[] args) {
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmInvocation] body = ; // array[PkmInvocation] | 

        try {
            'String' result = apiInstance.postInvocations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#postInvocations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InvocationsApi *apiInstance = [[InvocationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmInvocation] *body = ; // 

[apiInstance postInvocationsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InvocationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmInvocation]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postInvocations(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInvocationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InvocationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmInvocation](); // array[PkmInvocation] | 

            try {
                'String' result = apiInstance.postInvocations(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvocationsApi.postInvocations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvocationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmInvocation] | 

try {
    $result = $api_instance->postInvocations($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvocationsApi->postInvocations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvocationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvocationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmInvocation]->new()]; # array[PkmInvocation] | 

eval {
    my $result = $api_instance->postInvocations(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvocationsApi->postInvocations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InvocationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmInvocation] | 

try:
    api_response = api_instance.post_invocations(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvocationsApi->postInvocations: %s\n" % e)
extern crate InvocationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmInvocation]

    let mut context = InvocationsApi::Context::default();
    let result = client.postInvocations(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Invocation documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putInvocations

Insert (if not yet present) or update (if already present) some Invocation documents into the database


/invocations/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/invocations/{dbName}" \
 -d '{
  "timestampRequest" : "timestampRequest",
  "invocationConfiguration" : "{}",
  "timestampCompleted" : "timestampCompleted",
  "invocationResults" : [ {
    "path" : "path",
    "type" : "type"
  }, {
    "path" : "path",
    "type" : "type"
  } ],
  "timestampStart" : "timestampStart",
  "invocationID" : "invocationID",
  "user" : "user",
  "tool" : "tool",
  "invocationStatus" : "PENDING"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvocationsApi;

import java.io.File;
import java.util.*;

public class InvocationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmInvocation] body = ; // array[PkmInvocation] | 

        try {
            'String' result = apiInstance.putInvocations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#putInvocations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InvocationsApi;

public class InvocationsApiExample {
    public static void main(String[] args) {
        InvocationsApi apiInstance = new InvocationsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmInvocation] body = ; // array[PkmInvocation] | 

        try {
            'String' result = apiInstance.putInvocations(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvocationsApi#putInvocations");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InvocationsApi *apiInstance = [[InvocationsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmInvocation] *body = ; // 

[apiInstance putInvocationsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.InvocationsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmInvocation]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putInvocations(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putInvocationsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InvocationsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmInvocation](); // array[PkmInvocation] | 

            try {
                'String' result = apiInstance.putInvocations(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvocationsApi.putInvocations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvocationsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmInvocation] | 

try {
    $result = $api_instance->putInvocations($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvocationsApi->putInvocations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvocationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvocationsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmInvocation]->new()]; # array[PkmInvocation] | 

eval {
    my $result = $api_instance->putInvocations(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvocationsApi->putInvocations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InvocationsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmInvocation] | 

try:
    api_response = api_instance.put_invocations(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvocationsApi->putInvocations: %s\n" % e)
extern crate InvocationsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmInvocation]

    let mut context = InvocationsApi::Context::default();
    let result = client.putInvocations(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Invocation documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Log

deleteLog

Delete a Log document from the database


/log/{dbName}/{artefactId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/log/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LogApi;

import java.io.File;
import java.util.*;

public class LogApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the Log document
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteLog(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#deleteLog");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LogApi;

public class LogApiExample {
    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the Log document
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteLog(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#deleteLog");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LogApi *apiInstance = [[LogApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // the ID of the Log document (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteLogWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.LogApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} the ID of the Log document
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteLog(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteLogExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new LogApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | the ID of the Log document (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteLog(dbName, artefactId, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling LogApi.deleteLog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LogApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | the ID of the Log document
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteLog($dbName, $artefactId, $key);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->deleteLog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LogApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LogApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | the ID of the Log document
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteLog(dbName => $dbName, artefactId => $artefactId, key => $key);
};
if ($@) {
    warn "Exception when calling LogApi->deleteLog: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LogApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | the ID of the Log document (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_log(dbName, artefactId, key)
except ApiException as e:
    print("Exception when calling LogApi->deleteLog: %s\n" % e)
extern crate LogApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = LogApi::Context::default();
    let result = client.deleteLog(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
the ID of the Log document
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteLogs

Delete all Log documents from the database


/log/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/log/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LogApi;

import java.io.File;
import java.util.*;

public class LogApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteLogs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#deleteLogs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LogApi;

public class LogApiExample {
    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteLogs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#deleteLogs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LogApi *apiInstance = [[LogApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteLogsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.LogApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteLogs(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteLogsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new LogApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteLogs(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling LogApi.deleteLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LogApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteLogs($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->deleteLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LogApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LogApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteLogs(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling LogApi->deleteLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LogApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_logs(dbName, key)
except ApiException as e:
    print("Exception when calling LogApi->deleteLogs: %s\n" % e)
extern crate LogApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = LogApi::Context::default();
    let result = client.deleteLogs(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getLog

Get a Log document from the database


/log/{dbName}/{artefactId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/log/{dbName}/{artefactId}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LogApi;

import java.io.File;
import java.util.*;

public class LogApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the Log document
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint

        try {
            PkmLog result = apiInstance.getLog(dbName, artefactId, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#getLog");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LogApi;

public class LogApiExample {
    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of the Log document
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint

        try {
            PkmLog result = apiInstance.getLog(dbName, artefactId, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#getLog");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LogApi *apiInstance = [[LogApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // the ID of the Log document (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getLogWith:dbName
    artefactId:artefactId
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmLog output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.LogApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} the ID of the Log document
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLog(dbName, artefactId, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getLogExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new LogApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | the ID of the Log document (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmLog result = apiInstance.getLog(dbName, artefactId, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LogApi.getLog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LogApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | the ID of the Log document
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getLog($dbName, $artefactId, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->getLog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LogApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LogApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | the ID of the Log document
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getLog(dbName => $dbName, artefactId => $artefactId, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LogApi->getLog: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LogApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | the ID of the Log document (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_log(dbName, artefactId, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogApi->getLog: %s\n" % e)
extern crate LogApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = LogApi::Context::default();
    let result = client.getLog(dbName, artefactId, key, abbrev, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
the ID of the Log document
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getLogs

Get all Log documents from the database


/log/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/log/{dbName}?abbrev=true&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LogApi;

import java.io.File;
import java.util.*;

public class LogApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmLog] result = apiInstance.getLogs(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#getLogs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LogApi;

public class LogApiExample {
    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmLog] result = apiInstance.getLogs(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#getLogs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LogApi *apiInstance = [[LogApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint (optional) (default to false)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getLogsWith:dbName
    key:key
    abbrev:abbrev
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmLog] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.LogApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLogs(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getLogsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new LogApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint (optional)  (default to false)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmLog] result = apiInstance.getLogs(dbName, key, abbrev, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LogApi.getLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LogApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getLogs($dbName, $key, $abbrev, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->getLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LogApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LogApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getLogs(dbName => $dbName, key => $key, abbrev => $abbrev, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LogApi->getLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LogApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint (optional) (default to false)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_logs(dbName, key, abbrev=abbrev, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogApi->getLogs: %s\n" % e)
extern crate LogApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = LogApi::Context::default();
    let result = client.getLogs(dbName, key, abbrev, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without messages, warnings, errors, and details properties)/full response, useful for lowering response footprint
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postLogs

Post one or more Log documents into the database


/log/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/log/{dbName}" \
 -d '{
  "start running time" : "start running time",
  "end running time" : "end running time",
  "nature of report" : "nature of report",
  "details" : "{}",
  "id" : "id",
  "tool" : "tool",
  "status" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LogApi;

import java.io.File;
import java.util.*;

public class LogApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmLog] body = ; // array[PkmLog] | 

        try {
            array['String'] result = apiInstance.postLogs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#postLogs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LogApi;

public class LogApiExample {
    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmLog] body = ; // array[PkmLog] | 

        try {
            array['String'] result = apiInstance.postLogs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#postLogs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LogApi *apiInstance = [[LogApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmLog] *body = ; // 

[apiInstance postLogsWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.LogApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmLog]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postLogs(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postLogsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new LogApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmLog](); // array[PkmLog] | 

            try {
                array['String'] result = apiInstance.postLogs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LogApi.postLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LogApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmLog] | 

try {
    $result = $api_instance->postLogs($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->postLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LogApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LogApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmLog]->new()]; # array[PkmLog] | 

eval {
    my $result = $api_instance->postLogs(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LogApi->postLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LogApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmLog] | 

try:
    api_response = api_instance.post_logs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogApi->postLogs: %s\n" % e)
extern crate LogApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmLog]

    let mut context = LogApi::Context::default();
    let result = client.postLogs(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Log documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putLogs

Insert (if not yet present) or update (if already present) one or more Log documents into the database


/log/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/log/{dbName}" \
 -d '{
  "start running time" : "start running time",
  "end running time" : "end running time",
  "nature of report" : "nature of report",
  "details" : "{}",
  "id" : "id",
  "tool" : "tool",
  "status" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LogApi;

import java.io.File;
import java.util.*;

public class LogApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmLog] body = ; // array[PkmLog] | 

        try {
            array['String'] result = apiInstance.putLogs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#putLogs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LogApi;

public class LogApiExample {
    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmLog] body = ; // array[PkmLog] | 

        try {
            array['String'] result = apiInstance.putLogs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#putLogs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LogApi *apiInstance = [[LogApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmLog] *body = ; // 

[apiInstance putLogsWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.LogApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmLog]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putLogs(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putLogsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new LogApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmLog](); // array[PkmLog] | 

            try {
                array['String'] result = apiInstance.putLogs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LogApi.putLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LogApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmLog] | 

try {
    $result = $api_instance->putLogs($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->putLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LogApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LogApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmLog]->new()]; # array[PkmLog] | 

eval {
    my $result = $api_instance->putLogs(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LogApi->putLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LogApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmLog] | 

try:
    api_response = api_instance.put_logs(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogApi->putLogs: %s\n" % e)
extern crate LogApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmLog]

    let mut context = LogApi::Context::default();
    let result = client.putLogs(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Log documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Methodology

deleteMethodologyStatus

Delete Methodology status


/methodology/status/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/methodology/status/{dbName}?id=id_example&name=name_example&phaseNumber=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MethodologyApi;

import java.io.File;
import java.util.*;

public class MethodologyApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String id = id_example; // String | phase identifier
        String name = name_example; // String | phase name
        Integer phaseNumber = 56; // Integer | phase number

        try {
            apiInstance.deleteMethodologyStatus(dbName, key, id, name, phaseNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#deleteMethodologyStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MethodologyApi;

public class MethodologyApiExample {
    public static void main(String[] args) {
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String id = id_example; // String | phase identifier
        String name = name_example; // String | phase name
        Integer phaseNumber = 56; // Integer | phase number

        try {
            apiInstance.deleteMethodologyStatus(dbName, key, id, name, phaseNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#deleteMethodologyStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MethodologyApi *apiInstance = [[MethodologyApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *id = id_example; // phase identifier (optional) (default to null)
String *name = name_example; // phase name (optional) (default to null)
Integer *phaseNumber = 56; // phase number (optional) (default to null)

[apiInstance deleteMethodologyStatusWith:dbName
    key:key
    id:id
    name:name
    phaseNumber:phaseNumber
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.MethodologyApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': id_example, // {String} phase identifier
  'name': name_example, // {String} phase name
  'phaseNumber': 56 // {Integer} phase number
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMethodologyStatus(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteMethodologyStatusExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new MethodologyApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = id_example;  // String | phase identifier (optional)  (default to null)
            var name = name_example;  // String | phase name (optional)  (default to null)
            var phaseNumber = 56;  // Integer | phase number (optional)  (default to null)

            try {
                apiInstance.deleteMethodologyStatus(dbName, key, id, name, phaseNumber);
            } catch (Exception e) {
                Debug.Print("Exception when calling MethodologyApi.deleteMethodologyStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MethodologyApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = id_example; // String | phase identifier
$name = name_example; // String | phase name
$phaseNumber = 56; // Integer | phase number

try {
    $api_instance->deleteMethodologyStatus($dbName, $key, $id, $name, $phaseNumber);
} catch (Exception $e) {
    echo 'Exception when calling MethodologyApi->deleteMethodologyStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MethodologyApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MethodologyApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = id_example; # String | phase identifier
my $name = name_example; # String | phase name
my $phaseNumber = 56; # Integer | phase number

eval {
    $api_instance->deleteMethodologyStatus(dbName => $dbName, key => $key, id => $id, name => $name, phaseNumber => $phaseNumber);
};
if ($@) {
    warn "Exception when calling MethodologyApi->deleteMethodologyStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MethodologyApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = id_example # String | phase identifier (optional) (default to null)
name = name_example # String | phase name (optional) (default to null)
phaseNumber = 56 # Integer | phase number (optional) (default to null)

try:
    api_instance.delete_methodology_status(dbName, key, id=id, name=name, phaseNumber=phaseNumber)
except ApiException as e:
    print("Exception when calling MethodologyApi->deleteMethodologyStatus: %s\n" % e)
extern crate MethodologyApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = id_example; // String
    let name = name_example; // String
    let phaseNumber = 56; // Integer

    let mut context = MethodologyApi::Context::default();
    let result = client.deleteMethodologyStatus(dbName, key, id, name, phaseNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
String
phase identifier
name
String
phase name
phaseNumber
Integer
phase number

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getMethodologyStatus

Get Methodology status


/methodology/status/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/methodology/status/{dbName}?id=id_example&name=name_example&phaseNumber=56&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MethodologyApi;

import java.io.File;
import java.util.*;

public class MethodologyApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String id = id_example; // String | phase identifier
        String name = name_example; // String | phase name
        Integer phaseNumber = 56; // Integer | phase number
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmMethodologyStatus] result = apiInstance.getMethodologyStatus(dbName, key, id, name, phaseNumber, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#getMethodologyStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MethodologyApi;

public class MethodologyApiExample {
    public static void main(String[] args) {
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String id = id_example; // String | phase identifier
        String name = name_example; // String | phase name
        Integer phaseNumber = 56; // Integer | phase number
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmMethodologyStatus] result = apiInstance.getMethodologyStatus(dbName, key, id, name, phaseNumber, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#getMethodologyStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MethodologyApi *apiInstance = [[MethodologyApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *id = id_example; // phase identifier (optional) (default to null)
String *name = name_example; // phase name (optional) (default to null)
Integer *phaseNumber = 56; // phase number (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getMethodologyStatusWith:dbName
    key:key
    id:id
    name:name
    phaseNumber:phaseNumber
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmMethodologyStatus] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.MethodologyApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'id': id_example, // {String} phase identifier
  'name': name_example, // {String} phase name
  'phaseNumber': 56, // {Integer} phase number
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMethodologyStatus(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMethodologyStatusExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new MethodologyApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var id = id_example;  // String | phase identifier (optional)  (default to null)
            var name = name_example;  // String | phase name (optional)  (default to null)
            var phaseNumber = 56;  // Integer | phase number (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmMethodologyStatus] result = apiInstance.getMethodologyStatus(dbName, key, id, name, phaseNumber, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MethodologyApi.getMethodologyStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MethodologyApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$id = id_example; // String | phase identifier
$name = name_example; // String | phase name
$phaseNumber = 56; // Integer | phase number
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getMethodologyStatus($dbName, $key, $id, $name, $phaseNumber, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MethodologyApi->getMethodologyStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MethodologyApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MethodologyApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $id = id_example; # String | phase identifier
my $name = name_example; # String | phase name
my $phaseNumber = 56; # Integer | phase number
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getMethodologyStatus(dbName => $dbName, key => $key, id => $id, name => $name, phaseNumber => $phaseNumber, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MethodologyApi->getMethodologyStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MethodologyApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
id = id_example # String | phase identifier (optional) (default to null)
name = name_example # String | phase name (optional) (default to null)
phaseNumber = 56 # Integer | phase number (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_methodology_status(dbName, key, id=id, name=name, phaseNumber=phaseNumber, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MethodologyApi->getMethodologyStatus: %s\n" % e)
extern crate MethodologyApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let id = id_example; // String
    let name = name_example; // String
    let phaseNumber = 56; // Integer
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = MethodologyApi::Context::default();
    let result = client.getMethodologyStatus(dbName, key, id, name, phaseNumber, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
id
String
phase identifier
name
String
phase name
phaseNumber
Integer
phase number
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postMethodologyStatus

Insert Methodology status


/methodology/status/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/methodology/status/{dbName}" \
 -d '{
  "phaseNumber" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "completed" : true,
  "tasks" : [ {
    "name" : "name",
    "taskNumber" : 6,
    "id" : "id",
    "completed" : true
  }, {
    "name" : "name",
    "taskNumber" : 6,
    "id" : "id",
    "completed" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MethodologyApi;

import java.io.File;
import java.util.*;

public class MethodologyApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmMethodologyStatus] body = ; // array[PkmMethodologyStatus] | 

        try {
            'String' result = apiInstance.postMethodologyStatus(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#postMethodologyStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MethodologyApi;

public class MethodologyApiExample {
    public static void main(String[] args) {
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmMethodologyStatus] body = ; // array[PkmMethodologyStatus] | 

        try {
            'String' result = apiInstance.postMethodologyStatus(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#postMethodologyStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MethodologyApi *apiInstance = [[MethodologyApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmMethodologyStatus] *body = ; // 

[apiInstance postMethodologyStatusWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.MethodologyApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmMethodologyStatus]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postMethodologyStatus(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postMethodologyStatusExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new MethodologyApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmMethodologyStatus](); // array[PkmMethodologyStatus] | 

            try {
                'String' result = apiInstance.postMethodologyStatus(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MethodologyApi.postMethodologyStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MethodologyApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmMethodologyStatus] | 

try {
    $result = $api_instance->postMethodologyStatus($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MethodologyApi->postMethodologyStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MethodologyApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MethodologyApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmMethodologyStatus]->new()]; # array[PkmMethodologyStatus] | 

eval {
    my $result = $api_instance->postMethodologyStatus(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MethodologyApi->postMethodologyStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MethodologyApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmMethodologyStatus] | 

try:
    api_response = api_instance.post_methodology_status(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MethodologyApi->postMethodologyStatus: %s\n" % e)
extern crate MethodologyApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmMethodologyStatus]

    let mut context = MethodologyApi::Context::default();
    let result = client.postMethodologyStatus(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Methodology status

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putMethodologyStatus

Insert Methodology status or update existing one


/methodology/status/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/methodology/status/{dbName}" \
 -d '{
  "phaseNumber" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "completed" : true,
  "tasks" : [ {
    "name" : "name",
    "taskNumber" : 6,
    "id" : "id",
    "completed" : true
  }, {
    "name" : "name",
    "taskNumber" : 6,
    "id" : "id",
    "completed" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MethodologyApi;

import java.io.File;
import java.util.*;

public class MethodologyApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmMethodologyStatus] body = ; // array[PkmMethodologyStatus] | 

        try {
            apiInstance.putMethodologyStatus(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#putMethodologyStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MethodologyApi;

public class MethodologyApiExample {
    public static void main(String[] args) {
        MethodologyApi apiInstance = new MethodologyApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmMethodologyStatus] body = ; // array[PkmMethodologyStatus] | 

        try {
            apiInstance.putMethodologyStatus(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling MethodologyApi#putMethodologyStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MethodologyApi *apiInstance = [[MethodologyApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmMethodologyStatus] *body = ; // 

[apiInstance putMethodologyStatusWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.MethodologyApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmMethodologyStatus]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putMethodologyStatus(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putMethodologyStatusExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new MethodologyApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmMethodologyStatus](); // array[PkmMethodologyStatus] | 

            try {
                apiInstance.putMethodologyStatus(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling MethodologyApi.putMethodologyStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MethodologyApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmMethodologyStatus] | 

try {
    $api_instance->putMethodologyStatus($dbName, $key, $body);
} catch (Exception $e) {
    echo 'Exception when calling MethodologyApi->putMethodologyStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MethodologyApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MethodologyApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmMethodologyStatus]->new()]; # array[PkmMethodologyStatus] | 

eval {
    $api_instance->putMethodologyStatus(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling MethodologyApi->putMethodologyStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MethodologyApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmMethodologyStatus] | 

try:
    api_instance.put_methodology_status(dbName, key, body)
except ApiException as e:
    print("Exception when calling MethodologyApi->putMethodologyStatus: %s\n" % e)
extern crate MethodologyApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmMethodologyStatus]

    let mut context = MethodologyApi::Context::default();
    let result = client.putMethodologyStatus(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Methodology status

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Project

deleteProject

delete a project


/project/{projectName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/project/{projectName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectName = projectName_example; // String | Project name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteProject(projectName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectName = projectName_example; // String | Project name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteProject(projectName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectName = projectName_example; // Project name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteProjectWith:projectName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ProjectApi()
var projectName = projectName_example; // {String} Project name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(projectName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectName = projectName_example;  // String | Project name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteProject(projectName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectName = projectName_example; // String | Project name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteProject($projectName, $key);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectName = projectName_example; # String | Project name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteProject(projectName => $projectName, key => $key);
};
if ($@) {
    warn "Exception when calling ProjectApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectName = projectName_example # String | Project name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_project(projectName, key)
except ApiException as e:
    print("Exception when calling ProjectApi->deleteProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectName = projectName_example; // String
    let key = key_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.deleteProject(projectName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectName*
String
Project name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getProject

Get a project


/project/{projectName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/project/{projectName}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectName = projectName_example; // String | Project name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            PkmProject result = apiInstance.getProject(projectName, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectName = projectName_example; // String | Project name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            PkmProject result = apiInstance.getProject(projectName, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectName = projectName_example; // Project name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getProjectWith:projectName
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmProject output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ProjectApi()
var projectName = projectName_example; // {String} Project name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(projectName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProjectExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectName = projectName_example;  // String | Project name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmProject result = apiInstance.getProject(projectName, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectName = projectName_example; // String | Project name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getProject($projectName, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectName = projectName_example; # String | Project name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getProject(projectName => $projectName, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectName = projectName_example # String | Project name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_project(projectName, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectName = projectName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = ProjectApi::Context::default();
    let result = client.getProject(projectName, key, abbrev, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectName*
String
Project name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getProjects

Get all projects


/project

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/project?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            array[PkmProject] result = apiInstance.getProjects(key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjects");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            array[PkmProject] result = apiInstance.getProjects(key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjects");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getProjectsWith:key
    abbrev:abbrev
              completionHandler: ^(array[PkmProject] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ProjectApi()
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjects(key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProjectsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                array[PkmProject] result = apiInstance.getProjects(key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.getProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getProjects($key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getProjects(key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProjects: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_projects(key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProjects: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = ProjectApi::Context::default();
    let result = client.getProjects(key, abbrev, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postProject

create a project


/project

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/project" \
 -d '{
  "members" : [ {
    "owner" : true,
    "roles" : [ "Owner", "Owner" ],
    "name" : "name"
  }, {
    "owner" : true,
    "roles" : [ "Owner", "Owner" ],
    "name" : "name"
  } ],
  "name" : "name",
  "methodologyStatus" : [ {
    "phaseNumber" : 0,
    "name" : "name",
    "description" : "description",
    "id" : "id",
    "completed" : true,
    "tasks" : [ {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    }, {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    } ]
  }, {
    "phaseNumber" : 0,
    "name" : "name",
    "description" : "description",
    "id" : "id",
    "completed" : true,
    "tasks" : [ {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    }, {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    } ]
  } ],
  "tools" : [ {
    "minutesToStuck" : 0,
    "toolID" : "toolID",
    "server" : "server",
    "endpoint" : {
      "path" : "path",
      "method" : "get",
      "pathFields" : [ {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      }, {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      } ],
      "queryParameters" : [ {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      }, {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      } ],
      "requestBody" : "{}"
    },
    "description" : "description",
    "phases" : [ "HLD", "HLD" ],
    "tasks" : [ "requirements", "requirements" ],
    "toolName" : "toolName"
  }, {
    "minutesToStuck" : 0,
    "toolID" : "toolID",
    "server" : "server",
    "endpoint" : {
      "path" : "path",
      "method" : "get",
      "pathFields" : [ {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      }, {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      } ],
      "queryParameters" : [ {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      }, {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      } ],
      "requestBody" : "{}"
    },
    "description" : "description",
    "phases" : [ "HLD", "HLD" ],
    "tasks" : [ "requirements", "requirements" ],
    "toolName" : "toolName"
  } ],
  "testarSettings" : "{}"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String key = key_example; // String | Access key to the PKM
        PkmProject body = ; // PkmProject | 

        try {
            'String' result = apiInstance.postProject(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#postProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String key = key_example; // String | Access key to the PKM
        PkmProject body = ; // PkmProject | 

        try {
            'String' result = apiInstance.postProject(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#postProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)
PkmProject *body = ; // 

[apiInstance postProjectWith:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ProjectApi()
var key = key_example; // {String} Access key to the PKM
var body = ; // {PkmProject} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postProject(key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postProjectExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new PkmProject(); // PkmProject | 

            try {
                'String' result = apiInstance.postProject(key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.postProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$key = key_example; // String | Access key to the PKM
$body = ; // PkmProject | 

try {
    $result = $api_instance->postProject($key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->postProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::PkmProject->new(); # PkmProject | 

eval {
    my $result = $api_instance->postProject(key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->postProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
key = key_example # String | Access key to the PKM (default to null)
body =  # PkmProject | 

try:
    api_response = api_instance.post_project(key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->postProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let key = key_example; // String
    let body = ; // PkmProject

    let mut context = ProjectApi::Context::default();
    let result = client.postProject(key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putProject

Put a project (create or update)


/project

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/project" \
 -d '{
  "members" : [ {
    "owner" : true,
    "roles" : [ "Owner", "Owner" ],
    "name" : "name"
  }, {
    "owner" : true,
    "roles" : [ "Owner", "Owner" ],
    "name" : "name"
  } ],
  "name" : "name",
  "methodologyStatus" : [ {
    "phaseNumber" : 0,
    "name" : "name",
    "description" : "description",
    "id" : "id",
    "completed" : true,
    "tasks" : [ {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    }, {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    } ]
  }, {
    "phaseNumber" : 0,
    "name" : "name",
    "description" : "description",
    "id" : "id",
    "completed" : true,
    "tasks" : [ {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    }, {
      "name" : "name",
      "taskNumber" : 6,
      "id" : "id",
      "completed" : true
    } ]
  } ],
  "tools" : [ {
    "minutesToStuck" : 0,
    "toolID" : "toolID",
    "server" : "server",
    "endpoint" : {
      "path" : "path",
      "method" : "get",
      "pathFields" : [ {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      }, {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      } ],
      "queryParameters" : [ {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      }, {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      } ],
      "requestBody" : "{}"
    },
    "description" : "description",
    "phases" : [ "HLD", "HLD" ],
    "tasks" : [ "requirements", "requirements" ],
    "toolName" : "toolName"
  }, {
    "minutesToStuck" : 0,
    "toolID" : "toolID",
    "server" : "server",
    "endpoint" : {
      "path" : "path",
      "method" : "get",
      "pathFields" : [ {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      }, {
        "artifactDesc" : {
          "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
          "type:" : "type:"
        },
        "name" : "name",
        "description" : "description",
        "isDBName" : true,
        "type" : "type",
        "required" : true
      } ],
      "queryParameters" : [ {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      }, {
        "allowedValues" : [ "allowedValues", "allowedValues" ],
        "name" : "name",
        "description" : "description",
        "type" : "type",
        "required" : true
      } ],
      "requestBody" : "{}"
    },
    "description" : "description",
    "phases" : [ "HLD", "HLD" ],
    "tasks" : [ "requirements", "requirements" ],
    "toolName" : "toolName"
  } ],
  "testarSettings" : "{}"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String key = key_example; // String | Access key to the PKM
        PkmProject body = ; // PkmProject | 

        try {
            'String' result = apiInstance.putProject(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#putProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String key = key_example; // String | Access key to the PKM
        PkmProject body = ; // PkmProject | 

        try {
            'String' result = apiInstance.putProject(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#putProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)
PkmProject *body = ; // 

[apiInstance putProjectWith:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ProjectApi()
var key = key_example; // {String} Access key to the PKM
var body = ; // {PkmProject} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putProject(key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putProjectExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new PkmProject(); // PkmProject | 

            try {
                'String' result = apiInstance.putProject(key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.putProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$key = key_example; // String | Access key to the PKM
$body = ; // PkmProject | 

try {
    $result = $api_instance->putProject($key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->putProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::PkmProject->new(); # PkmProject | 

eval {
    my $result = $api_instance->putProject(key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->putProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
key = key_example # String | Access key to the PKM (default to null)
body =  # PkmProject | 

try:
    api_response = api_instance.put_project(key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->putProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let key = key_example; // String
    let body = ; // PkmProject

    let mut context = ProjectApi::Context::default();
    let result = client.putProject(key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Reviews

deleteReviews

Delete Reviews


/reviews/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/reviews/{dbName}?reviewID=reviewID_example&reviewAuthor=reviewAuthor_example&reviewStatus=reviewStatus_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReviewsApi;

import java.io.File;
import java.util.*;

public class ReviewsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String reviewID = reviewID_example; // String | review identifier
        String reviewAuthor = reviewAuthor_example; // String | review author
        String reviewStatus = reviewStatus_example; // String | review status

        try {
            apiInstance.deleteReviews(dbName, key, reviewID, reviewAuthor, reviewStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#deleteReviews");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReviewsApi;

public class ReviewsApiExample {
    public static void main(String[] args) {
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String reviewID = reviewID_example; // String | review identifier
        String reviewAuthor = reviewAuthor_example; // String | review author
        String reviewStatus = reviewStatus_example; // String | review status

        try {
            apiInstance.deleteReviews(dbName, key, reviewID, reviewAuthor, reviewStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#deleteReviews");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ReviewsApi *apiInstance = [[ReviewsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *reviewID = reviewID_example; // review identifier (optional) (default to null)
String *reviewAuthor = reviewAuthor_example; // review author (optional) (default to null)
String *reviewStatus = reviewStatus_example; // review status (optional) (default to null)

[apiInstance deleteReviewsWith:dbName
    key:key
    reviewID:reviewID
    reviewAuthor:reviewAuthor
    reviewStatus:reviewStatus
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ReviewsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'reviewID': reviewID_example, // {String} review identifier
  'reviewAuthor': reviewAuthor_example, // {String} review author
  'reviewStatus': reviewStatus_example // {String} review status
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteReviews(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteReviewsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ReviewsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var reviewID = reviewID_example;  // String | review identifier (optional)  (default to null)
            var reviewAuthor = reviewAuthor_example;  // String | review author (optional)  (default to null)
            var reviewStatus = reviewStatus_example;  // String | review status (optional)  (default to null)

            try {
                apiInstance.deleteReviews(dbName, key, reviewID, reviewAuthor, reviewStatus);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReviewsApi.deleteReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReviewsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$reviewID = reviewID_example; // String | review identifier
$reviewAuthor = reviewAuthor_example; // String | review author
$reviewStatus = reviewStatus_example; // String | review status

try {
    $api_instance->deleteReviews($dbName, $key, $reviewID, $reviewAuthor, $reviewStatus);
} catch (Exception $e) {
    echo 'Exception when calling ReviewsApi->deleteReviews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReviewsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReviewsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $reviewID = reviewID_example; # String | review identifier
my $reviewAuthor = reviewAuthor_example; # String | review author
my $reviewStatus = reviewStatus_example; # String | review status

eval {
    $api_instance->deleteReviews(dbName => $dbName, key => $key, reviewID => $reviewID, reviewAuthor => $reviewAuthor, reviewStatus => $reviewStatus);
};
if ($@) {
    warn "Exception when calling ReviewsApi->deleteReviews: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ReviewsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
reviewID = reviewID_example # String | review identifier (optional) (default to null)
reviewAuthor = reviewAuthor_example # String | review author (optional) (default to null)
reviewStatus = reviewStatus_example # String | review status (optional) (default to null)

try:
    api_instance.delete_reviews(dbName, key, reviewID=reviewID, reviewAuthor=reviewAuthor, reviewStatus=reviewStatus)
except ApiException as e:
    print("Exception when calling ReviewsApi->deleteReviews: %s\n" % e)
extern crate ReviewsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let reviewID = reviewID_example; // String
    let reviewAuthor = reviewAuthor_example; // String
    let reviewStatus = reviewStatus_example; // String

    let mut context = ReviewsApi::Context::default();
    let result = client.deleteReviews(dbName, key, reviewID, reviewAuthor, reviewStatus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
reviewID
String
review identifier
reviewAuthor
String
review author
reviewStatus
String
review status

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getReviews

Get Reviews


/reviews/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/reviews/{dbName}?reviewID=reviewID_example&reviewAuthor=reviewAuthor_example&reviewStatus=reviewStatus_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReviewsApi;

import java.io.File;
import java.util.*;

public class ReviewsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String reviewID = reviewID_example; // String | review identifier
        String reviewAuthor = reviewAuthor_example; // String | review author
        String reviewStatus = reviewStatus_example; // String | review status
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmReview] result = apiInstance.getReviews(dbName, key, reviewID, reviewAuthor, reviewStatus, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#getReviews");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReviewsApi;

public class ReviewsApiExample {
    public static void main(String[] args) {
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String reviewID = reviewID_example; // String | review identifier
        String reviewAuthor = reviewAuthor_example; // String | review author
        String reviewStatus = reviewStatus_example; // String | review status
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmReview] result = apiInstance.getReviews(dbName, key, reviewID, reviewAuthor, reviewStatus, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#getReviews");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ReviewsApi *apiInstance = [[ReviewsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *reviewID = reviewID_example; // review identifier (optional) (default to null)
String *reviewAuthor = reviewAuthor_example; // review author (optional) (default to null)
String *reviewStatus = reviewStatus_example; // review status (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getReviewsWith:dbName
    key:key
    reviewID:reviewID
    reviewAuthor:reviewAuthor
    reviewStatus:reviewStatus
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmReview] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ReviewsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'reviewID': reviewID_example, // {String} review identifier
  'reviewAuthor': reviewAuthor_example, // {String} review author
  'reviewStatus': reviewStatus_example, // {String} review status
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReviews(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getReviewsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ReviewsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var reviewID = reviewID_example;  // String | review identifier (optional)  (default to null)
            var reviewAuthor = reviewAuthor_example;  // String | review author (optional)  (default to null)
            var reviewStatus = reviewStatus_example;  // String | review status (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmReview] result = apiInstance.getReviews(dbName, key, reviewID, reviewAuthor, reviewStatus, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReviewsApi.getReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReviewsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$reviewID = reviewID_example; // String | review identifier
$reviewAuthor = reviewAuthor_example; // String | review author
$reviewStatus = reviewStatus_example; // String | review status
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getReviews($dbName, $key, $reviewID, $reviewAuthor, $reviewStatus, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReviewsApi->getReviews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReviewsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReviewsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $reviewID = reviewID_example; # String | review identifier
my $reviewAuthor = reviewAuthor_example; # String | review author
my $reviewStatus = reviewStatus_example; # String | review status
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getReviews(dbName => $dbName, key => $key, reviewID => $reviewID, reviewAuthor => $reviewAuthor, reviewStatus => $reviewStatus, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReviewsApi->getReviews: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ReviewsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
reviewID = reviewID_example # String | review identifier (optional) (default to null)
reviewAuthor = reviewAuthor_example # String | review author (optional) (default to null)
reviewStatus = reviewStatus_example # String | review status (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_reviews(dbName, key, reviewID=reviewID, reviewAuthor=reviewAuthor, reviewStatus=reviewStatus, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReviewsApi->getReviews: %s\n" % e)
extern crate ReviewsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let reviewID = reviewID_example; // String
    let reviewAuthor = reviewAuthor_example; // String
    let reviewStatus = reviewStatus_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = ReviewsApi::Context::default();
    let result = client.getReviews(dbName, key, reviewID, reviewAuthor, reviewStatus, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
reviewID
String
review identifier
reviewAuthor
String
review author
reviewStatus
String
review status
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postReviews

Insert Reviews


/reviews/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/reviews/{dbName}" \
 -d '{
  "reviewAuthor" : "reviewAuthor",
  "reviewStatus" : "OPEN",
  "reviewOpenDate" : "reviewOpenDate",
  "reviewComments" : [ {
    "datetime" : "datetime",
    "author" : "author",
    "comment" : "comment"
  }, {
    "datetime" : "datetime",
    "author" : "author",
    "comment" : "comment"
  } ],
  "reviewID" : "reviewID",
  "reviewTitle" : "reviewTitle",
  "reviewCompletedDate" : "reviewCompletedDate",
  "reviewArtifacts" : [ {
    "path" : "path",
    "type" : "Diagram"
  }, {
    "path" : "path",
    "type" : "Diagram"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReviewsApi;

import java.io.File;
import java.util.*;

public class ReviewsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmReview] body = ; // array[PkmReview] | 

        try {
            array['String'] result = apiInstance.postReviews(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#postReviews");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReviewsApi;

public class ReviewsApiExample {
    public static void main(String[] args) {
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmReview] body = ; // array[PkmReview] | 

        try {
            array['String'] result = apiInstance.postReviews(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#postReviews");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ReviewsApi *apiInstance = [[ReviewsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmReview] *body = ; // 

[apiInstance postReviewsWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ReviewsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmReview]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postReviews(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postReviewsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ReviewsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmReview](); // array[PkmReview] | 

            try {
                array['String'] result = apiInstance.postReviews(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReviewsApi.postReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReviewsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmReview] | 

try {
    $result = $api_instance->postReviews($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReviewsApi->postReviews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReviewsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReviewsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmReview]->new()]; # array[PkmReview] | 

eval {
    my $result = $api_instance->postReviews(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReviewsApi->postReviews: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ReviewsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmReview] | 

try:
    api_response = api_instance.post_reviews(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReviewsApi->postReviews: %s\n" % e)
extern crate ReviewsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmReview]

    let mut context = ReviewsApi::Context::default();
    let result = client.postReviews(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Reviews

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putReviews

Insert Reviews or update existing ones


/reviews/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/reviews/{dbName}" \
 -d '{
  "reviewAuthor" : "reviewAuthor",
  "reviewStatus" : "OPEN",
  "reviewOpenDate" : "reviewOpenDate",
  "reviewComments" : [ {
    "datetime" : "datetime",
    "author" : "author",
    "comment" : "comment"
  }, {
    "datetime" : "datetime",
    "author" : "author",
    "comment" : "comment"
  } ],
  "reviewID" : "reviewID",
  "reviewTitle" : "reviewTitle",
  "reviewCompletedDate" : "reviewCompletedDate",
  "reviewArtifacts" : [ {
    "path" : "path",
    "type" : "Diagram"
  }, {
    "path" : "path",
    "type" : "Diagram"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ReviewsApi;

import java.io.File;
import java.util.*;

public class ReviewsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmReview] body = ; // array[PkmReview] | 

        try {
            array['String'] result = apiInstance.putReviews(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#putReviews");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ReviewsApi;

public class ReviewsApiExample {
    public static void main(String[] args) {
        ReviewsApi apiInstance = new ReviewsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmReview] body = ; // array[PkmReview] | 

        try {
            array['String'] result = apiInstance.putReviews(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReviewsApi#putReviews");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ReviewsApi *apiInstance = [[ReviewsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmReview] *body = ; // 

[apiInstance putReviewsWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ReviewsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmReview]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putReviews(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putReviewsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ReviewsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmReview](); // array[PkmReview] | 

            try {
                array['String'] result = apiInstance.putReviews(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ReviewsApi.putReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ReviewsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmReview] | 

try {
    $result = $api_instance->putReviews($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReviewsApi->putReviews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ReviewsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ReviewsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmReview]->new()]; # array[PkmReview] | 

eval {
    my $result = $api_instance->putReviews(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReviewsApi->putReviews: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ReviewsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmReview] | 

try:
    api_response = api_instance.put_reviews(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReviewsApi->putReviews: %s\n" % e)
extern crate ReviewsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmReview]

    let mut context = ReviewsApi::Context::default();
    let result = client.putReviews(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Reviews

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

ServerInfo

getServerInfo

Returns information about the PKM instance


/server_info

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/server_info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServerInfoApi;

import java.io.File;
import java.util.*;

public class ServerInfoApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ServerInfoApi apiInstance = new ServerInfoApi();

        try {
            PkmServerInfo result = apiInstance.getServerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerInfoApi#getServerInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServerInfoApi;

public class ServerInfoApiExample {
    public static void main(String[] args) {
        ServerInfoApi apiInstance = new ServerInfoApi();

        try {
            PkmServerInfo result = apiInstance.getServerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServerInfoApi#getServerInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ServerInfoApi *apiInstance = [[ServerInfoApi alloc] init];

[apiInstance getServerInfoWithCompletionHandler: 
              ^(PkmServerInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ServerInfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getServerInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getServerInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ServerInfoApi();

            try {
                PkmServerInfo result = apiInstance.getServerInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServerInfoApi.getServerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServerInfoApi();

try {
    $result = $api_instance->getServerInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerInfoApi->getServerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ServerInfoApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ServerInfoApi->new();

eval {
    my $result = $api_instance->getServerInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServerInfoApi->getServerInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ServerInfoApi()

try:
    api_response = api_instance.get_server_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServerInfoApi->getServerInfo: %s\n" % e)
extern crate ServerInfoApi;

pub fn main() {

    let mut context = ServerInfoApi::Context::default();
    let result = client.getServerInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

TESTAR

deleteTESTARSettings

Delete TESTAR settings


/testar/settings/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/settings/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTESTARSettings(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#deleteTESTARSettings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTESTARSettings(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#deleteTESTARSettings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteTESTARSettingsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTESTARSettings(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTESTARSettingsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTESTARSettings(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.deleteTESTARSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTESTARSettings($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->deleteTESTARSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTESTARSettings(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling TESTARApi->deleteTESTARSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_testar_settings(dbName, key)
except ApiException as e:
    print("Exception when calling TESTARApi->deleteTESTARSettings: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = TESTARApi::Context::default();
    let result = client.deleteTESTARSettings(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteTESTARStateModel

Delete Specific TESTAR StateModel JSON Artefact from the database


/testar/state_model/{dbName}/{artefactId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/state_model/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTESTARStateModel(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#deleteTESTARStateModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTESTARStateModel(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#deleteTESTARStateModel");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // ArtefactId (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteTESTARStateModelWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} ArtefactId
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTESTARStateModel(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTESTARStateModelExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | ArtefactId (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTESTARStateModel(dbName, artefactId, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.deleteTESTARStateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | ArtefactId
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTESTARStateModel($dbName, $artefactId, $key);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->deleteTESTARStateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | ArtefactId
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTESTARStateModel(dbName => $dbName, artefactId => $artefactId, key => $key);
};
if ($@) {
    warn "Exception when calling TESTARApi->deleteTESTARStateModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | ArtefactId (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_testar_state_model(dbName, artefactId, key)
except ApiException as e:
    print("Exception when calling TESTARApi->deleteTESTARStateModel: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = TESTARApi::Context::default();
    let result = client.deleteTESTARStateModel(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
ArtefactId
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteTESTARTestResults

Delete Specific TESTAR TestResults JSON Artefact from the database


/testar/test_results/{dbName}/{artefactId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/test_results/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTESTARTestResults(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#deleteTESTARTestResults");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTESTARTestResults(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#deleteTESTARTestResults");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // ArtefactId (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteTESTARTestResultsWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} ArtefactId
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTESTARTestResults(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTESTARTestResultsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | ArtefactId (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTESTARTestResults(dbName, artefactId, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.deleteTESTARTestResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | ArtefactId
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTESTARTestResults($dbName, $artefactId, $key);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->deleteTESTARTestResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | ArtefactId
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTESTARTestResults(dbName => $dbName, artefactId => $artefactId, key => $key);
};
if ($@) {
    warn "Exception when calling TESTARApi->deleteTESTARTestResults: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | ArtefactId (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_testar_test_results(dbName, artefactId, key)
except ApiException as e:
    print("Exception when calling TESTARApi->deleteTESTARTestResults: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = TESTARApi::Context::default();
    let result = client.deleteTESTARTestResults(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
ArtefactId
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getAllTESTARStateModel

Get All TESTAR StateModel JSON Artefacts from the database


/testar/state_model/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/state_model/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[TestarStateModel] result = apiInstance.getAllTESTARStateModel(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getAllTESTARStateModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[TestarStateModel] result = apiInstance.getAllTESTARStateModel(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getAllTESTARStateModel");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getAllTESTARStateModelWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[TestarStateModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllTESTARStateModel(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllTESTARStateModelExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[TestarStateModel] result = apiInstance.getAllTESTARStateModel(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.getAllTESTARStateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getAllTESTARStateModel($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->getAllTESTARStateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getAllTESTARStateModel(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->getAllTESTARStateModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_all_testar_state_model(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->getAllTESTARStateModel: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = TESTARApi::Context::default();
    let result = client.getAllTESTARStateModel(dbName, key, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getAllTESTARTestResults

Get All TESTAR TestResults JSON Artefacts from the database


/testar/test_results/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/test_results/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[TestarTestResults] result = apiInstance.getAllTESTARTestResults(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getAllTESTARTestResults");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[TestarTestResults] result = apiInstance.getAllTESTARTestResults(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getAllTESTARTestResults");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getAllTESTARTestResultsWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[TestarTestResults] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllTESTARTestResults(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllTESTARTestResultsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[TestarTestResults] result = apiInstance.getAllTESTARTestResults(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.getAllTESTARTestResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getAllTESTARTestResults($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->getAllTESTARTestResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getAllTESTARTestResults(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->getAllTESTARTestResults: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_all_testar_test_results(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->getAllTESTARTestResults: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = TESTARApi::Context::default();
    let result = client.getAllTESTARTestResults(dbName, key, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTESTARSettings

Get TESTAR settings


/testar/settings/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/settings/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            Object result = apiInstance.getTESTARSettings(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getTESTARSettings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            Object result = apiInstance.getTESTARSettings(dbName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getTESTARSettings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getTESTARSettingsWith:dbName
    key:key
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTESTARSettings(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTESTARSettingsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                Object result = apiInstance.getTESTARSettings(dbName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.getTESTARSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getTESTARSettings($dbName, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->getTESTARSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getTESTARSettings(dbName => $dbName, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->getTESTARSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_testar_settings(dbName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->getTESTARSettings: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = TESTARApi::Context::default();
    let result = client.getTESTARSettings(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTESTARStateModel

Get Specific TESTAR StateModel JSON Artefact from the database


/testar/state_model/{dbName}/{artefactId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/state_model/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            TestarStateModel result = apiInstance.getTESTARStateModel(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getTESTARStateModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            TestarStateModel result = apiInstance.getTESTARStateModel(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getTESTARStateModel");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // ArtefactId (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getTESTARStateModelWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(TestarStateModel output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} ArtefactId
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTESTARStateModel(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTESTARStateModelExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | ArtefactId (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                TestarStateModel result = apiInstance.getTESTARStateModel(dbName, artefactId, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.getTESTARStateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | ArtefactId
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getTESTARStateModel($dbName, $artefactId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->getTESTARStateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | ArtefactId
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getTESTARStateModel(dbName => $dbName, artefactId => $artefactId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->getTESTARStateModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | ArtefactId (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_testar_state_model(dbName, artefactId, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->getTESTARStateModel: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = TESTARApi::Context::default();
    let result = client.getTESTARStateModel(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
ArtefactId
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTESTARTestResults

Get Specific TESTAR TestResults JSON Artefact from the database


/testar/test_results/{dbName}/{artefactId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/testar/test_results/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            TestarTestResults result = apiInstance.getTESTARTestResults(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getTESTARTestResults");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | ArtefactId
        String key = key_example; // String | Access key to the PKM

        try {
            TestarTestResults result = apiInstance.getTESTARTestResults(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#getTESTARTestResults");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // ArtefactId (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getTESTARTestResultsWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(TestarTestResults output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} ArtefactId
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTESTARTestResults(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTESTARTestResultsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | ArtefactId (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                TestarTestResults result = apiInstance.getTESTARTestResults(dbName, artefactId, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.getTESTARTestResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | ArtefactId
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getTESTARTestResults($dbName, $artefactId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->getTESTARTestResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | ArtefactId
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getTESTARTestResults(dbName => $dbName, artefactId => $artefactId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->getTESTARTestResults: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | ArtefactId (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_testar_test_results(dbName, artefactId, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->getTESTARTestResults: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = TESTARApi::Context::default();
    let result = client.getTESTARTestResults(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
ArtefactId
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postTESTARSettings

Insert TESTAR settings


/testar/settings/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/testar/settings/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Object body = Object; // Object | 

        try {
            'String' result = apiInstance.postTESTARSettings(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#postTESTARSettings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Object body = Object; // Object | 

        try {
            'String' result = apiInstance.postTESTARSettings(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#postTESTARSettings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Object *body = Object; // 

[apiInstance postTESTARSettingsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTESTARSettings(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postTESTARSettingsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = Object;  // Object | 

            try {
                'String' result = apiInstance.postTESTARSettings(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.postTESTARSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = Object; // Object | 

try {
    $result = $api_instance->postTESTARSettings($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->postTESTARSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    my $result = $api_instance->postTESTARSettings(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->postTESTARSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body = Object # Object | 

try:
    api_response = api_instance.post_testar_settings(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->postTESTARSettings: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = Object; // Object

    let mut context = TESTARApi::Context::default();
    let result = client.postTESTARSettings(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

TESTAR settings

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postTESTARStateModel

Insert some StateModel JSON Artefacts into the database


/testar/state_model/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/testar/state_model/{dbName}" \
 -d '{
  "stateModelDifference" : {
    "existsPreviousStateModel" : false,
    "previousStateModelAppVersion" : "previousStateModelAppVersion",
    "numberDisappearedAbstractStates" : 0,
    "numberNewAbstractStates" : 6,
    "stateModelDifferenceReport" : "stateModelDifferenceReport",
    "previousStateModelAppName" : "previousStateModelAppName"
  },
  "deterministic" : false,
  "stateModelAppVersion" : "stateModelAppVersion",
  "abstractionId" : "abstractionId",
  "stateModelDataStorePassword" : "stateModelDataStorePassword",
  "stateModelDataStoreDB" : "stateModelDataStoreDB",
  "sut" : {
    "license" : "{}",
    "runtimeOS" : "runtimeOS"
  },
  "stateModelIdentifier" : "stateModelIdentifier",
  "stateModelDataStoreServer" : "stateModelDataStoreServer",
  "numberAbstractActions" : 5,
  "numberTestSequences" : 3,
  "timestamp" : "timestamp",
  "stateModelDataStoreType" : "stateModelDataStoreType",
  "numberAbstractStates" : 5,
  "numberConcreteStates" : 2,
  "numberConcreteActions" : 7,
  "stateModelDataStoreDirectory" : "stateModelDataStoreDirectory",
  "testSequences" : [ {
    "startDateTime" : "startDateTime",
    "sequenceActionSteps" : [ {
      "actionDescription" : "actionDescription",
      "timestamp" : "timestamp"
    }, {
      "actionDescription" : "actionDescription",
      "timestamp" : "timestamp"
    } ],
    "foundErrors" : false,
    "sequenceDeterministic" : false,
    "verdict" : "verdict",
    "sequenceId" : "sequenceId",
    "numberErrors" : 4,
    "numberSequenceNodes" : 2
  }, {
    "startDateTime" : "startDateTime",
    "sequenceActionSteps" : [ {
      "actionDescription" : "actionDescription",
      "timestamp" : "timestamp"
    }, {
      "actionDescription" : "actionDescription",
      "timestamp" : "timestamp"
    } ],
    "foundErrors" : false,
    "sequenceDeterministic" : false,
    "verdict" : "verdict",
    "sequenceId" : "sequenceId",
    "numberErrors" : 4,
    "numberSequenceNodes" : 2
  } ],
  "stateModelDataStoreUser" : "stateModelDataStoreUser",
  "url" : "url",
  "tool" : {
    "license" : "license",
    "runtimeOS" : "runtimeOS",
    "isOpenSource" : false,
    "name" : "name",
    "title" : "title",
    "version" : "version",
    "url" : "url"
  },
  "stateModelAppName" : "stateModelAppName",
  "stateModelDataStore" : "stateModelDataStore",
  "unvisitedAbstractActions" : 1,
  "numberWidgets" : 9,
  "storeWidgets" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        TestarStateModel body = ; // TestarStateModel | 

        try {
            pkm-testar-response result = apiInstance.postTESTARStateModel(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#postTESTARStateModel");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        TestarStateModel body = ; // TestarStateModel | 

        try {
            pkm-testar-response result = apiInstance.postTESTARStateModel(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#postTESTARStateModel");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
TestarStateModel *body = ; // 

[apiInstance postTESTARStateModelWith:dbName
    key:key
    body:body
              completionHandler: ^(pkm-testar-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {TestarStateModel} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTESTARStateModel(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postTESTARStateModelExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new TestarStateModel(); // TestarStateModel | 

            try {
                pkm-testar-response result = apiInstance.postTESTARStateModel(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.postTESTARStateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // TestarStateModel | 

try {
    $result = $api_instance->postTESTARStateModel($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->postTESTARStateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::TestarStateModel->new(); # TestarStateModel | 

eval {
    my $result = $api_instance->postTESTARStateModel(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->postTESTARStateModel: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # TestarStateModel | 

try:
    api_response = api_instance.post_testar_state_model(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->postTESTARStateModel: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // TestarStateModel

    let mut context = TESTARApi::Context::default();
    let result = client.postTESTARStateModel(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

TESTAR StateModel JSON Artefact

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postTESTARTestResults

Insert some TestResults JSON Artefacts into the database


/testar/test_results/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/testar/test_results/{dbName}" \
 -d '{
  "settings" : {
    "ApplicationVersion" : "ApplicationVersion",
    "discount" : 3.616076749251911,
    "MyClassPath" : "MyClassPath",
    "sutConnectorValue" : "sutConnectorValue",
    "DataStore" : "DataStore",
    "PKMdatabase" : "PKMdatabase",
    "clickFilter" : "clickFilter",
    "sutConnector" : "sutConnector",
    "DataStoreMode" : "DataStoreMode",
    "Sequences" : 6,
    "PKMkey" : "PKMkey",
    "DataStoreDB" : "DataStoreDB",
    "maxReward" : 9.301444243932576,
    "StartupTime" : 7.061401241503109,
    "SuspiciousProcessOutput" : "SuspiciousProcessOutput",
    "StateModelDifferenceAutomaticReport" : false,
    "PKMusername" : "PKMusername",
    "OutputDir" : "OutputDir",
    "actionDuration" : 5.962133916683182,
    "ProcessesToKillDuringTest" : "ProcessesToKillDuringTest",
    "ProcessListenerEnabled" : false,
    "OnlySaveFaultySequences" : false,
    "MaxTime" : 2.3021358869347655,
    "PreviousApplicationVersion" : "PreviousApplicationVersion",
    "ResetDataStore" : false,
    "DataStoreServer" : "DataStoreServer",
    "DataStoreType" : "DataStoreType",
    "timeToWaitAfterAction" : 5.637376656633329,
    "PKMaddress" : "PKMaddress",
    "suspiciousTitles" : "suspiciousTitles",
    "SequenceLength" : 0,
    "protocolClass" : "protocolClass",
    "TempDir" : "TempDir",
    "ApplicationName" : "ApplicationName",
    "AbstractStateAttributes" : "AbstractStateAttributes",
    "ProcessLogs" : "ProcessLogs",
    "Mode" : "Mode",
    "StateModelEnabled" : false,
    "DataStorePassword" : "DataStorePassword",
    "PreviousApplicationName" : "PreviousApplicationName",
    "ActionSelectionAlgorithm" : "ActionSelectionAlgorithm",
    "OverrideWebDriverDisplayScale" : "OverrideWebDriverDisplayScale",
    "PKMport" : "PKMport",
    "timeToFreeze" : 1.4658129805029452,
    "AccessBridgeEnabled" : false,
    "StateModelStoreWidgets" : false,
    "StopGenerationOnFault" : false,
    "forceForeground" : false,
    "DataStoreUser" : "DataStoreUser",
    "DataStoreDirectory" : "DataStoreDirectory"
  },
  "sequencesResult" : [ "sequencesResult", "sequencesResult" ],
  "sut" : {
    "license" : "{}",
    "runtimeOS" : "runtimeOS"
  },
  "htmlsResult" : [ "htmlsResult", "htmlsResult" ],
  "sequencesVerdicts" : [ "sequencesVerdicts", "sequencesVerdicts" ],
  "logsResult" : [ "logsResult", "logsResult" ],
  "url" : "url",
  "tool" : {
    "license" : "license",
    "runtimeOS" : "runtimeOS",
    "isOpenSource" : false,
    "name" : "name",
    "title" : "title",
    "version" : "version",
    "url" : "url"
  },
  "timestamp" : "timestamp"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        TestarTestResults body = ; // TestarTestResults | 

        try {
            pkm-testar-response result = apiInstance.postTESTARTestResults(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#postTESTARTestResults");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        TestarTestResults body = ; // TestarTestResults | 

        try {
            pkm-testar-response result = apiInstance.postTESTARTestResults(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#postTESTARTestResults");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
TestarTestResults *body = ; // 

[apiInstance postTESTARTestResultsWith:dbName
    key:key
    body:body
              completionHandler: ^(pkm-testar-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {TestarTestResults} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTESTARTestResults(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postTESTARTestResultsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new TestarTestResults(); // TestarTestResults | 

            try {
                pkm-testar-response result = apiInstance.postTESTARTestResults(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.postTESTARTestResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // TestarTestResults | 

try {
    $result = $api_instance->postTESTARTestResults($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->postTESTARTestResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::TestarTestResults->new(); # TestarTestResults | 

eval {
    my $result = $api_instance->postTESTARTestResults(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TESTARApi->postTESTARTestResults: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # TestarTestResults | 

try:
    api_response = api_instance.post_testar_test_results(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TESTARApi->postTESTARTestResults: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // TestarTestResults

    let mut context = TESTARApi::Context::default();
    let result = client.postTESTARTestResults(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

TESTAR TestResults JSON Artefact

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putTESTARSettings

Insert TESTAR settings or update existing ones


/testar/settings/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/testar/settings/{dbName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TESTARApi;

import java.io.File;
import java.util.*;

public class TESTARApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Object body = Object; // Object | 

        try {
            apiInstance.putTESTARSettings(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#putTESTARSettings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TESTARApi;

public class TESTARApiExample {
    public static void main(String[] args) {
        TESTARApi apiInstance = new TESTARApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Object body = Object; // Object | 

        try {
            apiInstance.putTESTARSettings(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TESTARApi#putTESTARSettings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TESTARApi *apiInstance = [[TESTARApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Object *body = Object; // 

[apiInstance putTESTARSettingsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TESTARApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putTESTARSettings(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putTESTARSettingsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TESTARApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = Object;  // Object | 

            try {
                apiInstance.putTESTARSettings(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling TESTARApi.putTESTARSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TESTARApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = Object; // Object | 

try {
    $api_instance->putTESTARSettings($dbName, $key, $body);
} catch (Exception $e) {
    echo 'Exception when calling TESTARApi->putTESTARSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TESTARApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TESTARApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    $api_instance->putTESTARSettings(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling TESTARApi->putTESTARSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TESTARApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body = Object # Object | 

try:
    api_instance.put_testar_settings(dbName, key, body)
except ApiException as e:
    print("Exception when calling TESTARApi->putTESTARSettings: %s\n" % e)
extern crate TESTARApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = Object; // Object

    let mut context = TESTARApi::Context::default();
    let result = client.putTESTARSettings(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

TESTAR settings

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Tools

deleteTool

delete a Tool document from the database


/tools/{dbName}/{toolID}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/tools/{dbName}/{toolID}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ToolsApi;

import java.io.File;
import java.util.*;

public class ToolsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String toolID = toolID_example; // String | Tool ID
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTool(dbName, toolID, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#deleteTool");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ToolsApi;

public class ToolsApiExample {
    public static void main(String[] args) {
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String toolID = toolID_example; // String | Tool ID
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTool(dbName, toolID, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#deleteTool");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ToolsApi *apiInstance = [[ToolsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *toolID = toolID_example; // Tool ID (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteToolWith:dbName
    toolID:toolID
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ToolsApi()
var dbName = dbName_example; // {String} Database name
var toolID = toolID_example; // {String} Tool ID
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTool(dbName, toolID, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteToolExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ToolsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var toolID = toolID_example;  // String | Tool ID (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTool(dbName, toolID, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling ToolsApi.deleteTool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ToolsApi();
$dbName = dbName_example; // String | Database name
$toolID = toolID_example; // String | Tool ID
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTool($dbName, $toolID, $key);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->deleteTool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ToolsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ToolsApi->new();
my $dbName = dbName_example; # String | Database name
my $toolID = toolID_example; # String | Tool ID
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTool(dbName => $dbName, toolID => $toolID, key => $key);
};
if ($@) {
    warn "Exception when calling ToolsApi->deleteTool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ToolsApi()
dbName = dbName_example # String | Database name (default to null)
toolID = toolID_example # String | Tool ID (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_tool(dbName, toolID, key)
except ApiException as e:
    print("Exception when calling ToolsApi->deleteTool: %s\n" % e)
extern crate ToolsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let toolID = toolID_example; // String
    let key = key_example; // String

    let mut context = ToolsApi::Context::default();
    let result = client.deleteTool(dbName, toolID, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
toolID*
String
Tool ID
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteTools

Delete all Tool documents present in the database


/tools/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/tools/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ToolsApi;

import java.io.File;
import java.util.*;

public class ToolsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTools(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#deleteTools");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ToolsApi;

public class ToolsApiExample {
    public static void main(String[] args) {
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTools(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#deleteTools");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ToolsApi *apiInstance = [[ToolsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteToolsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ToolsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTools(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteToolsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ToolsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTools(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling ToolsApi.deleteTools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ToolsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTools($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->deleteTools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ToolsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ToolsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTools(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling ToolsApi->deleteTools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ToolsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_tools(dbName, key)
except ApiException as e:
    print("Exception when calling ToolsApi->deleteTools: %s\n" % e)
extern crate ToolsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = ToolsApi::Context::default();
    let result = client.deleteTools(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTool

Get Tool documents by Tool ID from the database


/tools/{dbName}/{toolID}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/tools/{dbName}/{toolID}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ToolsApi;

import java.io.File;
import java.util.*;

public class ToolsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String toolID = toolID_example; // String | Tool ID
        String key = key_example; // String | Access key to the PKM

        try {
            PkmTool result = apiInstance.getTool(dbName, toolID, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#getTool");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ToolsApi;

public class ToolsApiExample {
    public static void main(String[] args) {
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String toolID = toolID_example; // String | Tool ID
        String key = key_example; // String | Access key to the PKM

        try {
            PkmTool result = apiInstance.getTool(dbName, toolID, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#getTool");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ToolsApi *apiInstance = [[ToolsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *toolID = toolID_example; // Tool ID (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getToolWith:dbName
    toolID:toolID
    key:key
              completionHandler: ^(PkmTool output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ToolsApi()
var dbName = dbName_example; // {String} Database name
var toolID = toolID_example; // {String} Tool ID
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTool(dbName, toolID, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getToolExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ToolsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var toolID = toolID_example;  // String | Tool ID (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmTool result = apiInstance.getTool(dbName, toolID, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ToolsApi.getTool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ToolsApi();
$dbName = dbName_example; // String | Database name
$toolID = toolID_example; // String | Tool ID
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getTool($dbName, $toolID, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->getTool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ToolsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ToolsApi->new();
my $dbName = dbName_example; # String | Database name
my $toolID = toolID_example; # String | Tool ID
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getTool(dbName => $dbName, toolID => $toolID, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ToolsApi->getTool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ToolsApi()
dbName = dbName_example # String | Database name (default to null)
toolID = toolID_example # String | Tool ID (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_tool(dbName, toolID, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsApi->getTool: %s\n" % e)
extern crate ToolsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let toolID = toolID_example; // String
    let key = key_example; // String

    let mut context = ToolsApi::Context::default();
    let result = client.getTool(dbName, toolID, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
toolID*
String
Tool ID
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTools

Get all Tool documents from the database


/tools/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/tools/{dbName}?phase=phase_example&task=task_example&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ToolsApi;

import java.io.File;
import java.util.*;

public class ToolsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String phase = phase_example; // String | phase
        String task = task_example; // String | task
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmTool] result = apiInstance.getTools(dbName, key, phase, task, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#getTools");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ToolsApi;

public class ToolsApiExample {
    public static void main(String[] args) {
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        String phase = phase_example; // String | phase
        String task = task_example; // String | task
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmTool] result = apiInstance.getTools(dbName, key, phase, task, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#getTools");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ToolsApi *apiInstance = [[ToolsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
String *phase = phase_example; // phase (optional) (default to null)
String *task = task_example; // task (optional) (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getToolsWith:dbName
    key:key
    phase:phase
    task:task
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmTool] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ToolsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'phase': phase_example, // {String} phase
  'task': task_example, // {String} task
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTools(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getToolsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ToolsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var phase = phase_example;  // String | phase (optional)  (default to null)
            var task = task_example;  // String | task (optional)  (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmTool] result = apiInstance.getTools(dbName, key, phase, task, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ToolsApi.getTools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ToolsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$phase = phase_example; // String | phase
$task = task_example; // String | task
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getTools($dbName, $key, $phase, $task, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->getTools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ToolsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ToolsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $phase = phase_example; # String | phase
my $task = task_example; # String | task
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getTools(dbName => $dbName, key => $key, phase => $phase, task => $task, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ToolsApi->getTools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ToolsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
phase = phase_example # String | phase (optional) (default to null)
task = task_example # String | task (optional) (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_tools(dbName, key, phase=phase, task=task, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsApi->getTools: %s\n" % e)
extern crate ToolsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let phase = phase_example; // String
    let task = task_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = ToolsApi::Context::default();
    let result = client.getTools(dbName, key, phase, task, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
phase
String
phase
task
String
task
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postTools

Insert some Tool documents (which are not yet present) into the database


/tools/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/tools/{dbName}" \
 -d '{
  "minutesToStuck" : 0,
  "toolID" : "toolID",
  "server" : "server",
  "endpoint" : {
    "path" : "path",
    "method" : "get",
    "pathFields" : [ {
      "artifactDesc" : {
        "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
        "type:" : "type:"
      },
      "name" : "name",
      "description" : "description",
      "isDBName" : true,
      "type" : "type",
      "required" : true
    }, {
      "artifactDesc" : {
        "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
        "type:" : "type:"
      },
      "name" : "name",
      "description" : "description",
      "isDBName" : true,
      "type" : "type",
      "required" : true
    } ],
    "queryParameters" : [ {
      "allowedValues" : [ "allowedValues", "allowedValues" ],
      "name" : "name",
      "description" : "description",
      "type" : "type",
      "required" : true
    }, {
      "allowedValues" : [ "allowedValues", "allowedValues" ],
      "name" : "name",
      "description" : "description",
      "type" : "type",
      "required" : true
    } ],
    "requestBody" : "{}"
  },
  "description" : "description",
  "phases" : [ "HLD", "HLD" ],
  "tasks" : [ "requirements", "requirements" ],
  "toolName" : "toolName"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ToolsApi;

import java.io.File;
import java.util.*;

public class ToolsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTool] body = ; // array[PkmTool] | 

        try {
            'String' result = apiInstance.postTools(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#postTools");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ToolsApi;

public class ToolsApiExample {
    public static void main(String[] args) {
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTool] body = ; // array[PkmTool] | 

        try {
            'String' result = apiInstance.postTools(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#postTools");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ToolsApi *apiInstance = [[ToolsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmTool] *body = ; //  (optional)

[apiInstance postToolsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ToolsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'body':  // {array[PkmTool]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTools(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postToolsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ToolsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmTool](); // array[PkmTool] |  (optional) 

            try {
                'String' result = apiInstance.postTools(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ToolsApi.postTools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ToolsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmTool] | 

try {
    $result = $api_instance->postTools($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->postTools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ToolsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ToolsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmTool]->new()]; # array[PkmTool] | 

eval {
    my $result = $api_instance->postTools(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ToolsApi->postTools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ToolsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmTool] |  (optional)

try:
    api_response = api_instance.post_tools(dbName, key, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsApi->postTools: %s\n" % e)
extern crate ToolsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmTool]

    let mut context = ToolsApi::Context::default();
    let result = client.postTools(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body

Tool documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putTools

Insert (if not yet present) or update (if already present) some Tool documents into the database


/tools/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/tools/{dbName}" \
 -d '{
  "minutesToStuck" : 0,
  "toolID" : "toolID",
  "server" : "server",
  "endpoint" : {
    "path" : "path",
    "method" : "get",
    "pathFields" : [ {
      "artifactDesc" : {
        "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
        "type:" : "type:"
      },
      "name" : "name",
      "description" : "description",
      "isDBName" : true,
      "type" : "type",
      "required" : true
    }, {
      "artifactDesc" : {
        "allowedExtensions" : [ "allowedExtensions", "allowedExtensions" ],
        "type:" : "type:"
      },
      "name" : "name",
      "description" : "description",
      "isDBName" : true,
      "type" : "type",
      "required" : true
    } ],
    "queryParameters" : [ {
      "allowedValues" : [ "allowedValues", "allowedValues" ],
      "name" : "name",
      "description" : "description",
      "type" : "type",
      "required" : true
    }, {
      "allowedValues" : [ "allowedValues", "allowedValues" ],
      "name" : "name",
      "description" : "description",
      "type" : "type",
      "required" : true
    } ],
    "requestBody" : "{}"
  },
  "description" : "description",
  "phases" : [ "HLD", "HLD" ],
  "tasks" : [ "requirements", "requirements" ],
  "toolName" : "toolName"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ToolsApi;

import java.io.File;
import java.util.*;

public class ToolsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTool] body = ; // array[PkmTool] | 

        try {
            'String' result = apiInstance.putTools(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#putTools");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ToolsApi;

public class ToolsApiExample {
    public static void main(String[] args) {
        ToolsApi apiInstance = new ToolsApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTool] body = ; // array[PkmTool] | 

        try {
            'String' result = apiInstance.putTools(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ToolsApi#putTools");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ToolsApi *apiInstance = [[ToolsApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmTool] *body = ; //  (optional)

[apiInstance putToolsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.ToolsApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'body':  // {array[PkmTool]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putTools(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putToolsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ToolsApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmTool](); // array[PkmTool] |  (optional) 

            try {
                'String' result = apiInstance.putTools(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ToolsApi.putTools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ToolsApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmTool] | 

try {
    $result = $api_instance->putTools($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->putTools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ToolsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ToolsApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmTool]->new()]; # array[PkmTool] | 

eval {
    my $result = $api_instance->putTools(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ToolsApi->putTools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ToolsApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmTool] |  (optional)

try:
    api_response = api_instance.put_tools(dbName, key, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsApi->putTools: %s\n" % e)
extern crate ToolsApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmTool]

    let mut context = ToolsApi::Context::default();
    let result = client.putTools(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body

Tool documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

TraceabilityMatrix

deleteTraceabilityMatrix

Delete traceability matrix (all traceability matrix cell documents) from the database


/traceability_matrix/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/traceability_matrix/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TraceabilityMatrixApi;

import java.io.File;
import java.util.*;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTraceabilityMatrix(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#deleteTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TraceabilityMatrixApi;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTraceabilityMatrix(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#deleteTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TraceabilityMatrixApi *apiInstance = [[TraceabilityMatrixApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteTraceabilityMatrixWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TraceabilityMatrixApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTraceabilityMatrix(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTraceabilityMatrixExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TraceabilityMatrixApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTraceabilityMatrix(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling TraceabilityMatrixApi.deleteTraceabilityMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TraceabilityMatrixApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTraceabilityMatrix($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling TraceabilityMatrixApi->deleteTraceabilityMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TraceabilityMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TraceabilityMatrixApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTraceabilityMatrix(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling TraceabilityMatrixApi->deleteTraceabilityMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TraceabilityMatrixApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_traceability_matrix(dbName, key)
except ApiException as e:
    print("Exception when calling TraceabilityMatrixApi->deleteTraceabilityMatrix: %s\n" % e)
extern crate TraceabilityMatrixApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = TraceabilityMatrixApi::Context::default();
    let result = client.deleteTraceabilityMatrix(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteTraceabilityMatrixCell

Delete a traceability matrix cell document from the database


/traceability_matrix/{dbName}/{artefactId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/traceability_matrix/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TraceabilityMatrixApi;

import java.io.File;
import java.util.*;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of traceability matrix cell
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTraceabilityMatrixCell(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#deleteTraceabilityMatrixCell");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TraceabilityMatrixApi;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of traceability matrix cell
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteTraceabilityMatrixCell(dbName, artefactId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#deleteTraceabilityMatrixCell");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TraceabilityMatrixApi *apiInstance = [[TraceabilityMatrixApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // the ID of traceability matrix cell (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteTraceabilityMatrixCellWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TraceabilityMatrixApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} the ID of traceability matrix cell
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTraceabilityMatrixCell(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteTraceabilityMatrixCellExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TraceabilityMatrixApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | the ID of traceability matrix cell (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteTraceabilityMatrixCell(dbName, artefactId, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling TraceabilityMatrixApi.deleteTraceabilityMatrixCell: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TraceabilityMatrixApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | the ID of traceability matrix cell
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteTraceabilityMatrixCell($dbName, $artefactId, $key);
} catch (Exception $e) {
    echo 'Exception when calling TraceabilityMatrixApi->deleteTraceabilityMatrixCell: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TraceabilityMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TraceabilityMatrixApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | the ID of traceability matrix cell
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteTraceabilityMatrixCell(dbName => $dbName, artefactId => $artefactId, key => $key);
};
if ($@) {
    warn "Exception when calling TraceabilityMatrixApi->deleteTraceabilityMatrixCell: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TraceabilityMatrixApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | the ID of traceability matrix cell (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_traceability_matrix_cell(dbName, artefactId, key)
except ApiException as e:
    print("Exception when calling TraceabilityMatrixApi->deleteTraceabilityMatrixCell: %s\n" % e)
extern crate TraceabilityMatrixApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = TraceabilityMatrixApi::Context::default();
    let result = client.deleteTraceabilityMatrixCell(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
the ID of traceability matrix cell
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTraceabilityMatrix

Get traceability matrix (all traceability matrix cell documents) or a part of it with row number in range [ fromRow, toRow ] and column number in range [ fromColumn, toColumn ] from the database


/traceability_matrix/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/traceability_matrix/{dbName}?fromRow=56&fromColumn=56&toRow=56&toColumn=56&rowRole=rowRole_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TraceabilityMatrixApi;

import java.io.File;
import java.util.*;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer fromRow = 56; // Integer | number of rows to skip, useful for lowering response footprint
        Integer fromColumn = 56; // Integer | number of columns to skip, useful for lowering response footprint
        Integer toRow = 56; // Integer | last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint
        Integer toColumn = 56; // Integer | last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint
        String rowRole = rowRole_example; // String | role of row

        try {
            array[PkmTraceabilityMatrix] result = apiInstance.getTraceabilityMatrix(dbName, key, fromRow, fromColumn, toRow, toColumn, rowRole);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#getTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TraceabilityMatrixApi;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer fromRow = 56; // Integer | number of rows to skip, useful for lowering response footprint
        Integer fromColumn = 56; // Integer | number of columns to skip, useful for lowering response footprint
        Integer toRow = 56; // Integer | last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint
        Integer toColumn = 56; // Integer | last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint
        String rowRole = rowRole_example; // String | role of row

        try {
            array[PkmTraceabilityMatrix] result = apiInstance.getTraceabilityMatrix(dbName, key, fromRow, fromColumn, toRow, toColumn, rowRole);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#getTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TraceabilityMatrixApi *apiInstance = [[TraceabilityMatrixApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *fromRow = 56; // number of rows to skip, useful for lowering response footprint (optional) (default to 0)
Integer *fromColumn = 56; // number of columns to skip, useful for lowering response footprint (optional) (default to 0)
Integer *toRow = 56; // last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint (optional) (default to null)
Integer *toColumn = 56; // last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint (optional) (default to null)
String *rowRole = rowRole_example; // role of row (optional) (default to source)

[apiInstance getTraceabilityMatrixWith:dbName
    key:key
    fromRow:fromRow
    fromColumn:fromColumn
    toRow:toRow
    toColumn:toColumn
    rowRole:rowRole
              completionHandler: ^(array[PkmTraceabilityMatrix] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TraceabilityMatrixApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'fromRow': 56, // {Integer} number of rows to skip, useful for lowering response footprint
  'fromColumn': 56, // {Integer} number of columns to skip, useful for lowering response footprint
  'toRow': 56, // {Integer} last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint
  'toColumn': 56, // {Integer} last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint
  'rowRole': rowRole_example // {String} role of row
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTraceabilityMatrix(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTraceabilityMatrixExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TraceabilityMatrixApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var fromRow = 56;  // Integer | number of rows to skip, useful for lowering response footprint (optional)  (default to 0)
            var fromColumn = 56;  // Integer | number of columns to skip, useful for lowering response footprint (optional)  (default to 0)
            var toRow = 56;  // Integer | last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint (optional)  (default to null)
            var toColumn = 56;  // Integer | last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint (optional)  (default to null)
            var rowRole = rowRole_example;  // String | role of row (optional)  (default to source)

            try {
                array[PkmTraceabilityMatrix] result = apiInstance.getTraceabilityMatrix(dbName, key, fromRow, fromColumn, toRow, toColumn, rowRole);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TraceabilityMatrixApi.getTraceabilityMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TraceabilityMatrixApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$fromRow = 56; // Integer | number of rows to skip, useful for lowering response footprint
$fromColumn = 56; // Integer | number of columns to skip, useful for lowering response footprint
$toRow = 56; // Integer | last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint
$toColumn = 56; // Integer | last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint
$rowRole = rowRole_example; // String | role of row

try {
    $result = $api_instance->getTraceabilityMatrix($dbName, $key, $fromRow, $fromColumn, $toRow, $toColumn, $rowRole);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TraceabilityMatrixApi->getTraceabilityMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TraceabilityMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TraceabilityMatrixApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $fromRow = 56; # Integer | number of rows to skip, useful for lowering response footprint
my $fromColumn = 56; # Integer | number of columns to skip, useful for lowering response footprint
my $toRow = 56; # Integer | last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint
my $toColumn = 56; # Integer | last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint
my $rowRole = rowRole_example; # String | role of row

eval {
    my $result = $api_instance->getTraceabilityMatrix(dbName => $dbName, key => $key, fromRow => $fromRow, fromColumn => $fromColumn, toRow => $toRow, toColumn => $toColumn, rowRole => $rowRole);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TraceabilityMatrixApi->getTraceabilityMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TraceabilityMatrixApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
fromRow = 56 # Integer | number of rows to skip, useful for lowering response footprint (optional) (default to 0)
fromColumn = 56 # Integer | number of columns to skip, useful for lowering response footprint (optional) (default to 0)
toRow = 56 # Integer | last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint (optional) (default to null)
toColumn = 56 # Integer | last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint (optional) (default to null)
rowRole = rowRole_example # String | role of row (optional) (default to source)

try:
    api_response = api_instance.get_traceability_matrix(dbName, key, fromRow=fromRow, fromColumn=fromColumn, toRow=toRow, toColumn=toColumn, rowRole=rowRole)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TraceabilityMatrixApi->getTraceabilityMatrix: %s\n" % e)
extern crate TraceabilityMatrixApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let fromRow = 56; // Integer
    let fromColumn = 56; // Integer
    let toRow = 56; // Integer
    let toColumn = 56; // Integer
    let rowRole = rowRole_example; // String

    let mut context = TraceabilityMatrixApi::Context::default();
    let result = client.getTraceabilityMatrix(dbName, key, fromRow, fromColumn, toRow, toColumn, rowRole, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
fromRow
Integer
number of rows to skip, useful for lowering response footprint
fromColumn
Integer
number of columns to skip, useful for lowering response footprint
toRow
Integer
last row (should be >= fromRow otherwise resulting matrix is empty), useful for lowering response footprint
toColumn
Integer
last column (should be >= fromColumn otherwise resulting matrix is empty), useful for lowering response footprint
rowRole
String
role of row

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getTraceabilityMatrixCell

Get a traceability matrix cell document from the database


/traceability_matrix/{dbName}/{artefactId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/traceability_matrix/{dbName}/{artefactId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TraceabilityMatrixApi;

import java.io.File;
import java.util.*;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of traceability matrix cell
        String key = key_example; // String | Access key to the PKM

        try {
            PkmTraceabilityMatrix result = apiInstance.getTraceabilityMatrixCell(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#getTraceabilityMatrixCell");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TraceabilityMatrixApi;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String artefactId = artefactId_example; // String | the ID of traceability matrix cell
        String key = key_example; // String | Access key to the PKM

        try {
            PkmTraceabilityMatrix result = apiInstance.getTraceabilityMatrixCell(dbName, artefactId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#getTraceabilityMatrixCell");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TraceabilityMatrixApi *apiInstance = [[TraceabilityMatrixApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *artefactId = artefactId_example; // the ID of traceability matrix cell (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getTraceabilityMatrixCellWith:dbName
    artefactId:artefactId
    key:key
              completionHandler: ^(PkmTraceabilityMatrix output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TraceabilityMatrixApi()
var dbName = dbName_example; // {String} Database name
var artefactId = artefactId_example; // {String} the ID of traceability matrix cell
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTraceabilityMatrixCell(dbName, artefactId, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTraceabilityMatrixCellExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TraceabilityMatrixApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var artefactId = artefactId_example;  // String | the ID of traceability matrix cell (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmTraceabilityMatrix result = apiInstance.getTraceabilityMatrixCell(dbName, artefactId, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TraceabilityMatrixApi.getTraceabilityMatrixCell: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TraceabilityMatrixApi();
$dbName = dbName_example; // String | Database name
$artefactId = artefactId_example; // String | the ID of traceability matrix cell
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getTraceabilityMatrixCell($dbName, $artefactId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TraceabilityMatrixApi->getTraceabilityMatrixCell: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TraceabilityMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TraceabilityMatrixApi->new();
my $dbName = dbName_example; # String | Database name
my $artefactId = artefactId_example; # String | the ID of traceability matrix cell
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getTraceabilityMatrixCell(dbName => $dbName, artefactId => $artefactId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TraceabilityMatrixApi->getTraceabilityMatrixCell: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TraceabilityMatrixApi()
dbName = dbName_example # String | Database name (default to null)
artefactId = artefactId_example # String | the ID of traceability matrix cell (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_traceability_matrix_cell(dbName, artefactId, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TraceabilityMatrixApi->getTraceabilityMatrixCell: %s\n" % e)
extern crate TraceabilityMatrixApi;

pub fn main() {
    let dbName = dbName_example; // String
    let artefactId = artefactId_example; // String
    let key = key_example; // String

    let mut context = TraceabilityMatrixApi::Context::default();
    let result = client.getTraceabilityMatrixCell(dbName, artefactId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
artefactId*
String
the ID of traceability matrix cell
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postTraceabilityMatrix

Post one or more traceability matrix cells into the database


/traceability_matrix/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/traceability_matrix/{dbName}" \
 -d '{
  "trace" : {
    "role" : "role",
    "similarity" : 0.8008281904610115
  },
  "tgt_path" : "tgt_path",
  "src_path" : "src_path",
  "src_access" : "src_access",
  "tgt_access" : "tgt_access"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TraceabilityMatrixApi;

import java.io.File;
import java.util.*;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTraceabilityMatrix] body = ; // array[PkmTraceabilityMatrix] | 

        try {
            array['String'] result = apiInstance.postTraceabilityMatrix(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#postTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TraceabilityMatrixApi;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTraceabilityMatrix] body = ; // array[PkmTraceabilityMatrix] | 

        try {
            array['String'] result = apiInstance.postTraceabilityMatrix(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#postTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TraceabilityMatrixApi *apiInstance = [[TraceabilityMatrixApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmTraceabilityMatrix] *body = ; // 

[apiInstance postTraceabilityMatrixWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TraceabilityMatrixApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmTraceabilityMatrix]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTraceabilityMatrix(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postTraceabilityMatrixExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TraceabilityMatrixApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmTraceabilityMatrix](); // array[PkmTraceabilityMatrix] | 

            try {
                array['String'] result = apiInstance.postTraceabilityMatrix(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TraceabilityMatrixApi.postTraceabilityMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TraceabilityMatrixApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmTraceabilityMatrix] | 

try {
    $result = $api_instance->postTraceabilityMatrix($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TraceabilityMatrixApi->postTraceabilityMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TraceabilityMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TraceabilityMatrixApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmTraceabilityMatrix]->new()]; # array[PkmTraceabilityMatrix] | 

eval {
    my $result = $api_instance->postTraceabilityMatrix(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TraceabilityMatrixApi->postTraceabilityMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TraceabilityMatrixApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmTraceabilityMatrix] | 

try:
    api_response = api_instance.post_traceability_matrix(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TraceabilityMatrixApi->postTraceabilityMatrix: %s\n" % e)
extern crate TraceabilityMatrixApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmTraceabilityMatrix]

    let mut context = TraceabilityMatrixApi::Context::default();
    let result = client.postTraceabilityMatrix(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Traceability Matrix cell documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putTraceabilityMatrix

Insert (if not yet present) or update (if already present) one or more traceability matrix cells into the database


/traceability_matrix/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/traceability_matrix/{dbName}" \
 -d '{
  "trace" : {
    "role" : "role",
    "similarity" : 0.8008281904610115
  },
  "tgt_path" : "tgt_path",
  "src_path" : "src_path",
  "src_access" : "src_access",
  "tgt_access" : "tgt_access"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TraceabilityMatrixApi;

import java.io.File;
import java.util.*;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTraceabilityMatrix] body = ; // array[PkmTraceabilityMatrix] | 

        try {
            array['String'] result = apiInstance.putTraceabilityMatrix(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#putTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TraceabilityMatrixApi;

public class TraceabilityMatrixApiExample {
    public static void main(String[] args) {
        TraceabilityMatrixApi apiInstance = new TraceabilityMatrixApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmTraceabilityMatrix] body = ; // array[PkmTraceabilityMatrix] | 

        try {
            array['String'] result = apiInstance.putTraceabilityMatrix(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TraceabilityMatrixApi#putTraceabilityMatrix");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TraceabilityMatrixApi *apiInstance = [[TraceabilityMatrixApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmTraceabilityMatrix] *body = ; // 

[apiInstance putTraceabilityMatrixWith:dbName
    key:key
    body:body
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.TraceabilityMatrixApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmTraceabilityMatrix]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putTraceabilityMatrix(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putTraceabilityMatrixExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new TraceabilityMatrixApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmTraceabilityMatrix](); // array[PkmTraceabilityMatrix] | 

            try {
                array['String'] result = apiInstance.putTraceabilityMatrix(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TraceabilityMatrixApi.putTraceabilityMatrix: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TraceabilityMatrixApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmTraceabilityMatrix] | 

try {
    $result = $api_instance->putTraceabilityMatrix($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TraceabilityMatrixApi->putTraceabilityMatrix: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TraceabilityMatrixApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TraceabilityMatrixApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmTraceabilityMatrix]->new()]; # array[PkmTraceabilityMatrix] | 

eval {
    my $result = $api_instance->putTraceabilityMatrix(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TraceabilityMatrixApi->putTraceabilityMatrix: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TraceabilityMatrixApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmTraceabilityMatrix] | 

try:
    api_response = api_instance.put_traceability_matrix(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TraceabilityMatrixApi->putTraceabilityMatrix: %s\n" % e)
extern crate TraceabilityMatrixApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmTraceabilityMatrix]

    let mut context = TraceabilityMatrixApi::Context::default();
    let result = client.putTraceabilityMatrix(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Traceability Matrix cell documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

UML

deleteRawUML

delete a UML file from the database


/uml/rawuml/{dbName}/{filename}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/rawuml/{dbName}/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | UML filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawUML(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteRawUML");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | UML filename
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawUML(dbName, filename, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteRawUML");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // UML filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteRawUMLWith:dbName
    filename:filename
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} UML filename
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRawUML(dbName, filename, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteRawUMLExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | UML filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteRawUML(dbName, filename, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.deleteRawUML: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | UML filename
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteRawUML($dbName, $filename, $key);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->deleteRawUML: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | UML filename
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteRawUML(dbName => $dbName, filename => $filename, key => $key);
};
if ($@) {
    warn "Exception when calling UMLApi->deleteRawUML: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | UML filename (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_raw_uml(dbName, filename, key)
except ApiException as e:
    print("Exception when calling UMLApi->deleteRawUML: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.deleteRawUML(dbName, filename, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
UML filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteRawUMLs

Delete all UML files present in the database


/uml/rawuml/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/rawuml/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawUMLs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteRawUMLs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteRawUMLs(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteRawUMLs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteRawUMLsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRawUMLs(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteRawUMLsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteRawUMLs(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.deleteRawUMLs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteRawUMLs($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->deleteRawUMLs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteRawUMLs(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling UMLApi->deleteRawUMLs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_raw_umls(dbName, key)
except ApiException as e:
    print("Exception when calling UMLApi->deleteRawUMLs: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.deleteRawUMLs(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteUMLClassDiagrams

Delete all UML class diagrams present in the database


/uml/uml_class/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_class/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteUMLClassDiagrams(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteUMLClassDiagrams(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteUMLClassDiagramsWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUMLClassDiagrams(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUMLClassDiagramsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteUMLClassDiagrams(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.deleteUMLClassDiagrams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteUMLClassDiagrams($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->deleteUMLClassDiagrams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteUMLClassDiagrams(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling UMLApi->deleteUMLClassDiagrams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_uml_class_diagrams(dbName, key)
except ApiException as e:
    print("Exception when calling UMLApi->deleteUMLClassDiagrams: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.deleteUMLClassDiagrams(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteUMLStateMachines

Delete all UML state machines present in the database


/uml/uml_state_machine/{dbName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_state_machine/{dbName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteUMLStateMachines(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteUMLStateMachines");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteUMLStateMachines(dbName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#deleteUMLStateMachines");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteUMLStateMachinesWith:dbName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUMLStateMachines(dbName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUMLStateMachinesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteUMLStateMachines(dbName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.deleteUMLStateMachines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteUMLStateMachines($dbName, $key);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->deleteUMLStateMachines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteUMLStateMachines(dbName => $dbName, key => $key);
};
if ($@) {
    warn "Exception when calling UMLApi->deleteUMLStateMachines: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_uml_state_machines(dbName, key)
except ApiException as e:
    print("Exception when calling UMLApi->deleteUMLStateMachines: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.deleteUMLStateMachines(dbName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getRawUML

Get a single UML file from the database


/uml/rawuml/{dbName}/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/rawuml/{dbName}/{filename}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | UML filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getRawUML(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getRawUML");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String filename = filename_example; // String | UML filename
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

        try {
            PkmFile result = apiInstance.getRawUML(dbName, filename, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getRawUML");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *filename = filename_example; // UML filename (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getRawUMLWith:dbName
    filename:filename
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var filename = filename_example; // {String} UML filename
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRawUML(dbName, filename, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRawUMLExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var filename = filename_example;  // String | UML filename (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmFile result = apiInstance.getRawUML(dbName, filename, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getRawUML: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$filename = filename_example; // String | UML filename
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getRawUML($dbName, $filename, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getRawUML: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $filename = filename_example; # String | UML filename
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getRawUML(dbName => $dbName, filename => $filename, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getRawUML: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
filename = filename_example # String | UML filename (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_raw_uml(dbName, filename, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getRawUML: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let filename = filename_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = UMLApi::Context::default();
    let result = client.getRawUML(dbName, filename, key, abbrev, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
filename*
String
UML filename
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getRawUMLs

Get all UML files from the database


/uml/rawuml/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/rawuml/{dbName}?abbrev=true&skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getRawUMLs(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getRawUMLs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmFile] result = apiInstance.getRawUMLs(dbName, key, abbrev, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getRawUMLs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getRawUMLsWith:dbName
    key:key
    abbrev:abbrev
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true, // {Boolean} toggle abbreviated response (without content)/full response, useful for lowering response footprint
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRawUMLs(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRawUMLsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional)  (default to false)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmFile] result = apiInstance.getRawUMLs(dbName, key, abbrev, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getRawUMLs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getRawUMLs($dbName, $key, $abbrev, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getRawUMLs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getRawUMLs(dbName => $dbName, key => $key, abbrev => $abbrev, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getRawUMLs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (without content)/full response, useful for lowering response footprint (optional) (default to false)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_raw_umls(dbName, key, abbrev=abbrev, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getRawUMLs: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = UMLApi::Context::default();
    let result = client.getRawUMLs(dbName, key, abbrev, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (without content)/full response, useful for lowering response footprint
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUMLClass

Get UML classes by name from the database


/uml/uml_class/class/{dbName}/{className}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_class/class/{dbName}/{className}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | Class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getUMLClass(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLClass");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String className = className_example; // String | Class name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getUMLClass(dbName, className, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLClass");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *className = className_example; // Class name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getUMLClassWith:dbName
    className:className
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var className = className_example; // {String} Class name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUMLClass(dbName, className, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUMLClassExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var className = className_example;  // String | Class name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getUMLClass(dbName, className, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getUMLClass: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$className = className_example; // String | Class name
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getUMLClass($dbName, $className, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getUMLClass: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $className = className_example; # String | Class name
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getUMLClass(dbName => $dbName, className => $className, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getUMLClass: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
className = className_example # String | Class name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_uml_class(dbName, className, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getUMLClass: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let className = className_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.getUMLClass(dbName, className, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
className*
String
Class name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUMLClassDiagram

Get UML class diagram by name from the database


/uml/uml_class/{dbName}/{diagramName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_class/{dbName}/{diagramName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String diagramName = diagramName_example; // String | Class diagram name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getUMLClassDiagram(dbName, diagramName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLClassDiagram");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String diagramName = diagramName_example; // String | Class diagram name
        String key = key_example; // String | Access key to the PKM

        try {
            array[Object] result = apiInstance.getUMLClassDiagram(dbName, diagramName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLClassDiagram");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *diagramName = diagramName_example; // Class diagram name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getUMLClassDiagramWith:dbName
    diagramName:diagramName
    key:key
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var diagramName = diagramName_example; // {String} Class diagram name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUMLClassDiagram(dbName, diagramName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUMLClassDiagramExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var diagramName = diagramName_example;  // String | Class diagram name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[Object] result = apiInstance.getUMLClassDiagram(dbName, diagramName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getUMLClassDiagram: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$diagramName = diagramName_example; // String | Class diagram name
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getUMLClassDiagram($dbName, $diagramName, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getUMLClassDiagram: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $diagramName = diagramName_example; # String | Class diagram name
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getUMLClassDiagram(dbName => $dbName, diagramName => $diagramName, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getUMLClassDiagram: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
diagramName = diagramName_example # String | Class diagram name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_uml_class_diagram(dbName, diagramName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getUMLClassDiagram: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let diagramName = diagramName_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.getUMLClassDiagram(dbName, diagramName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
diagramName*
String
Class diagram name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUMLClassDiagrams

Get all UML class diagrams from the database


/uml/uml_class/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_class/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmUmlClassDiagram] result = apiInstance.getUMLClassDiagrams(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmUmlClassDiagram] result = apiInstance.getUMLClassDiagrams(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getUMLClassDiagramsWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmUmlClassDiagram] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUMLClassDiagrams(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUMLClassDiagramsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmUmlClassDiagram] result = apiInstance.getUMLClassDiagrams(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getUMLClassDiagrams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getUMLClassDiagrams($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getUMLClassDiagrams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getUMLClassDiagrams(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getUMLClassDiagrams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_uml_class_diagrams(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getUMLClassDiagrams: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = UMLApi::Context::default();
    let result = client.getUMLClassDiagrams(dbName, key, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUMLStateMachine

Get UML state machine by name from the database


/uml/uml_state_machine/{dbName}/{diagramName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_state_machine/{dbName}/{diagramName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String diagramName = diagramName_example; // String | Class diagram name
        String key = key_example; // String | Access key to the PKM

        try {
            array[PkmUmlStateMachine] result = apiInstance.getUMLStateMachine(dbName, diagramName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLStateMachine");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String diagramName = diagramName_example; // String | Class diagram name
        String key = key_example; // String | Access key to the PKM

        try {
            array[PkmUmlStateMachine] result = apiInstance.getUMLStateMachine(dbName, diagramName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLStateMachine");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *diagramName = diagramName_example; // Class diagram name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getUMLStateMachineWith:dbName
    diagramName:diagramName
    key:key
              completionHandler: ^(array[PkmUmlStateMachine] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var diagramName = diagramName_example; // {String} Class diagram name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUMLStateMachine(dbName, diagramName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUMLStateMachineExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var diagramName = diagramName_example;  // String | Class diagram name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                array[PkmUmlStateMachine] result = apiInstance.getUMLStateMachine(dbName, diagramName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getUMLStateMachine: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$diagramName = diagramName_example; // String | Class diagram name
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getUMLStateMachine($dbName, $diagramName, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getUMLStateMachine: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $diagramName = diagramName_example; # String | Class diagram name
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getUMLStateMachine(dbName => $dbName, diagramName => $diagramName, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getUMLStateMachine: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
diagramName = diagramName_example # String | Class diagram name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_uml_state_machine(dbName, diagramName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getUMLStateMachine: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let diagramName = diagramName_example; // String
    let key = key_example; // String

    let mut context = UMLApi::Context::default();
    let result = client.getUMLStateMachine(dbName, diagramName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
diagramName*
String
Class diagram name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUMLStateMachines

Get all UML state machines from the database


/uml/uml_state_machine/{dbName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_state_machine/{dbName}?skip=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmUmlStateMachine] result = apiInstance.getUMLStateMachines(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLStateMachines");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        Integer skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
        Integer limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

        try {
            array[PkmUmlStateMachine] result = apiInstance.getUMLStateMachines(dbName, key, skip, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#getUMLStateMachines");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Integer *skip = 56; // number of elements to skip, useful for lowering response footprint (optional) (default to 0)
Integer *limit = 56; // maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

[apiInstance getUMLStateMachinesWith:dbName
    key:key
    skip:skip
    limit:limit
              completionHandler: ^(array[PkmUmlStateMachine] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'skip': 56, // {Integer} number of elements to skip, useful for lowering response footprint
  'limit': 56 // {Integer} maximum number of elements in the response (zero means no limit), useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUMLStateMachines(dbName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUMLStateMachinesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var skip = 56;  // Integer | number of elements to skip, useful for lowering response footprint (optional)  (default to 0)
            var limit = 56;  // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional)  (default to 0)

            try {
                array[PkmUmlStateMachine] result = apiInstance.getUMLStateMachines(dbName, key, skip, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.getUMLStateMachines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$skip = 56; // Integer | number of elements to skip, useful for lowering response footprint
$limit = 56; // Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

try {
    $result = $api_instance->getUMLStateMachines($dbName, $key, $skip, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->getUMLStateMachines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $skip = 56; # Integer | number of elements to skip, useful for lowering response footprint
my $limit = 56; # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint

eval {
    my $result = $api_instance->getUMLStateMachines(dbName => $dbName, key => $key, skip => $skip, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->getUMLStateMachines: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
skip = 56 # Integer | number of elements to skip, useful for lowering response footprint (optional) (default to 0)
limit = 56 # Integer | maximum number of elements in the response (zero means no limit), useful for lowering response footprint (optional) (default to 0)

try:
    api_response = api_instance.get_uml_state_machines(dbName, key, skip=skip, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->getUMLStateMachines: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let skip = 56; // Integer
    let limit = 56; // Integer

    let mut context = UMLApi::Context::default();
    let result = client.getUMLStateMachines(dbName, key, skip, limit, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
skip
Integer
number of elements to skip, useful for lowering response footprint
limit
Integer
maximum number of elements in the response (zero means no limit), useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postRawUMLs

Insert some UML files (which are not yet present) into the database


/uml/rawuml/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/uml/rawuml/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postRawUMLs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#postRawUMLs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            'String' result = apiInstance.postRawUMLs(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#postRawUMLs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance postRawUMLsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postRawUMLs(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postRawUMLsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                'String' result = apiInstance.postRawUMLs(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.postRawUMLs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

try {
    $result = $api_instance->postRawUMLs($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->postRawUMLs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    my $result = $api_instance->postRawUMLs(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->postRawUMLs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_response = api_instance.post_raw_umls(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->postRawUMLs: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = UMLApi::Context::default();
    let result = client.postRawUMLs(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

UML files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postUMLClassDiagrams

Insert some UML class diagrams (which are not yet present) into the database


/uml/uml_class/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_class/{dbName}" \
 -d '{
  "diagram" : "diagram",
  "name" : "name",
  "type" : "type"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlClassDiagram] body = ; // array[PkmUmlClassDiagram] | 

        try {
            'String' result = apiInstance.postUMLClassDiagrams(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#postUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlClassDiagram] body = ; // array[PkmUmlClassDiagram] | 

        try {
            'String' result = apiInstance.postUMLClassDiagrams(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#postUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmUmlClassDiagram] *body = ; // 

[apiInstance postUMLClassDiagramsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmUmlClassDiagram]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postUMLClassDiagrams(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postUMLClassDiagramsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmUmlClassDiagram](); // array[PkmUmlClassDiagram] | 

            try {
                'String' result = apiInstance.postUMLClassDiagrams(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.postUMLClassDiagrams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmUmlClassDiagram] | 

try {
    $result = $api_instance->postUMLClassDiagrams($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->postUMLClassDiagrams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmUmlClassDiagram]->new()]; # array[PkmUmlClassDiagram] | 

eval {
    my $result = $api_instance->postUMLClassDiagrams(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->postUMLClassDiagrams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmUmlClassDiagram] | 

try:
    api_response = api_instance.post_uml_class_diagrams(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->postUMLClassDiagrams: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmUmlClassDiagram]

    let mut context = UMLApi::Context::default();
    let result = client.postUMLClassDiagrams(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

UML class diagram documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postUMLStateMachines

Insert some UML state machines (which are not yet present) into the database


/uml/uml_state_machine/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_state_machine/{dbName}" \
 -d '{
  "diagram" : "diagram",
  "regions" : [ {
    "subvertexes" : [ {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    }, {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    } ],
    "name" : "name",
    "id" : "id",
    "transitions" : [ {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    }, {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    } ]
  }, {
    "subvertexes" : [ {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    }, {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    } ],
    "name" : "name",
    "id" : "id",
    "transitions" : [ {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    }, {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    } ]
  } ],
  "name" : "name",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlStateMachine] body = ; // array[PkmUmlStateMachine] | 

        try {
            'String' result = apiInstance.postUMLStateMachines(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#postUMLStateMachines");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlStateMachine] body = ; // array[PkmUmlStateMachine] | 

        try {
            'String' result = apiInstance.postUMLStateMachines(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#postUMLStateMachines");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmUmlStateMachine] *body = ; // 

[apiInstance postUMLStateMachinesWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmUmlStateMachine]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postUMLStateMachines(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postUMLStateMachinesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmUmlStateMachine](); // array[PkmUmlStateMachine] | 

            try {
                'String' result = apiInstance.postUMLStateMachines(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.postUMLStateMachines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmUmlStateMachine] | 

try {
    $result = $api_instance->postUMLStateMachines($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->postUMLStateMachines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmUmlStateMachine]->new()]; # array[PkmUmlStateMachine] | 

eval {
    my $result = $api_instance->postUMLStateMachines(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->postUMLStateMachines: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmUmlStateMachine] | 

try:
    api_response = api_instance.post_uml_state_machines(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->postUMLStateMachines: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmUmlStateMachine]

    let mut context = UMLApi::Context::default();
    let result = client.postUMLStateMachines(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

UML state machine documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putRawUMLs

Insert (if not yet present) or update (if already present) some UML files into the database


/uml/rawuml/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/uml/rawuml/{dbName}" \
 -d '{
  "git_dirty" : true,
  "mime_type" : "mime_type",
  "format" : "text",
  "encoding" : "encoding",
  "type" : "type",
  "git_unmerged" : true,
  "rel_path" : "rel_path",
  "content" : "content",
  "git_working_tree" : "git_working_tree"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putRawUMLs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#putRawUMLs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmFile] body = ; // array[PkmFile] | 

        try {
            apiInstance.putRawUMLs(dbName, key, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#putRawUMLs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmFile] *body = ; // 

[apiInstance putRawUMLsWith:dbName
    key:key
    body:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmFile]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putRawUMLs(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putRawUMLsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmFile](); // array[PkmFile] | 

            try {
                apiInstance.putRawUMLs(dbName, key, body);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.putRawUMLs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmFile] | 

try {
    $api_instance->putRawUMLs($dbName, $key, $body);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->putRawUMLs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmFile]->new()]; # array[PkmFile] | 

eval {
    $api_instance->putRawUMLs(dbName => $dbName, key => $key, body => $body);
};
if ($@) {
    warn "Exception when calling UMLApi->putRawUMLs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmFile] | 

try:
    api_instance.put_raw_umls(dbName, key, body)
except ApiException as e:
    print("Exception when calling UMLApi->putRawUMLs: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmFile]

    let mut context = UMLApi::Context::default();
    let result = client.putRawUMLs(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

UML files

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putUMLClassDiagrams

Insert (if not yet present) or update (if already present) some UML class diagrams into the database


/uml/uml_class/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_class/{dbName}" \
 -d '{
  "diagram" : "diagram",
  "name" : "name",
  "type" : "type"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlClassDiagram] body = ; // array[PkmUmlClassDiagram] | 

        try {
            'String' result = apiInstance.putUMLClassDiagrams(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#putUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlClassDiagram] body = ; // array[PkmUmlClassDiagram] | 

        try {
            'String' result = apiInstance.putUMLClassDiagrams(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#putUMLClassDiagrams");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmUmlClassDiagram] *body = ; // 

[apiInstance putUMLClassDiagramsWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmUmlClassDiagram]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putUMLClassDiagrams(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putUMLClassDiagramsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmUmlClassDiagram](); // array[PkmUmlClassDiagram] | 

            try {
                'String' result = apiInstance.putUMLClassDiagrams(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.putUMLClassDiagrams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmUmlClassDiagram] | 

try {
    $result = $api_instance->putUMLClassDiagrams($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->putUMLClassDiagrams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmUmlClassDiagram]->new()]; # array[PkmUmlClassDiagram] | 

eval {
    my $result = $api_instance->putUMLClassDiagrams(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->putUMLClassDiagrams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmUmlClassDiagram] | 

try:
    api_response = api_instance.put_uml_class_diagrams(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->putUMLClassDiagrams: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmUmlClassDiagram]

    let mut context = UMLApi::Context::default();
    let result = client.putUMLClassDiagrams(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

UML class diagram documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putUMLStateMachines

Insert (if not yet present) or update (if already present) some UML state machines into the database


/uml/uml_state_machine/{dbName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/uml/uml_state_machine/{dbName}" \
 -d '{
  "diagram" : "diagram",
  "regions" : [ {
    "subvertexes" : [ {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    }, {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    } ],
    "name" : "name",
    "id" : "id",
    "transitions" : [ {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    }, {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    } ]
  }, {
    "subvertexes" : [ {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    }, {
      "isSourceOfTransition" : true,
      "previousSubvertexes" : [ "previousSubvertexes", "previousSubvertexes" ],
      "isTargetOfTransition" : true,
      "name" : "name",
      "nextSubvertexes" : [ "nextSubvertexes", "nextSubvertexes" ],
      "id" : "id",
      "type" : "type"
    } ],
    "name" : "name",
    "id" : "id",
    "transitions" : [ {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    }, {
      "sourceID" : "sourceID",
      "targetName" : "targetName",
      "targetID" : "targetID",
      "id" : "id",
      "sourceName" : "sourceName"
    } ]
  } ],
  "name" : "name",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UMLApi;

import java.io.File;
import java.util.*;

public class UMLApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlStateMachine] body = ; // array[PkmUmlStateMachine] | 

        try {
            'String' result = apiInstance.putUMLStateMachines(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#putUMLStateMachines");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UMLApi;

public class UMLApiExample {
    public static void main(String[] args) {
        UMLApi apiInstance = new UMLApi();
        String dbName = dbName_example; // String | Database name
        String key = key_example; // String | Access key to the PKM
        array[PkmUmlStateMachine] body = ; // array[PkmUmlStateMachine] | 

        try {
            'String' result = apiInstance.putUMLStateMachines(dbName, key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UMLApi#putUMLStateMachines");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UMLApi *apiInstance = [[UMLApi alloc] init];
String *dbName = dbName_example; // Database name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
array[PkmUmlStateMachine] *body = ; // 

[apiInstance putUMLStateMachinesWith:dbName
    key:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UMLApi()
var dbName = dbName_example; // {String} Database name
var key = key_example; // {String} Access key to the PKM
var body = ; // {array[PkmUmlStateMachine]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putUMLStateMachines(dbName, key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putUMLStateMachinesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UMLApi();
            var dbName = dbName_example;  // String | Database name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new array[PkmUmlStateMachine](); // array[PkmUmlStateMachine] | 

            try {
                'String' result = apiInstance.putUMLStateMachines(dbName, key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UMLApi.putUMLStateMachines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UMLApi();
$dbName = dbName_example; // String | Database name
$key = key_example; // String | Access key to the PKM
$body = ; // array[PkmUmlStateMachine] | 

try {
    $result = $api_instance->putUMLStateMachines($dbName, $key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UMLApi->putUMLStateMachines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UMLApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UMLApi->new();
my $dbName = dbName_example; # String | Database name
my $key = key_example; # String | Access key to the PKM
my $body = [WWW::OPenAPIClient::Object::array[PkmUmlStateMachine]->new()]; # array[PkmUmlStateMachine] | 

eval {
    my $result = $api_instance->putUMLStateMachines(dbName => $dbName, key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UMLApi->putUMLStateMachines: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UMLApi()
dbName = dbName_example # String | Database name (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # array[PkmUmlStateMachine] | 

try:
    api_response = api_instance.put_uml_state_machines(dbName, key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UMLApi->putUMLStateMachines: %s\n" % e)
extern crate UMLApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // array[PkmUmlStateMachine]

    let mut context = UMLApi::Context::default();
    let result = client.putUMLStateMachines(dbName, key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
Database name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

UML state machine documents

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

User

access

User's access. PKM access key validity is checked and session lifetime is extended until another session timeout (see session_timeout in PKM configuration)


/user/access

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/access"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.access(key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#access");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.access(key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#access");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance accessWith:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.access(key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accessExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.access(key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.access: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->access($key);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->access: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->access(key => $key);
};
if ($@) {
    warn "Exception when calling UserApi->access: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.access(key)
except ApiException as e:
    print("Exception when calling UserApi->access: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let key = key_example; // String

    let mut context = UserApi::Context::default();
    let result = client.access(key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

deleteUser

delete user


/user/{userName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/{userName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteUser(userName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.deleteUser(userName, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userName = userName_example; // user's name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance deleteUserWith:userName
    key:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var userName = userName_example; // {String} user's name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser(userName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userName = userName_example;  // String | user's name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.deleteUser(userName, key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userName = userName_example; // String | user's name
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->deleteUser($userName, $key);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userName = userName_example; # String | user's name
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->deleteUser(userName => $userName, key => $key);
};
if ($@) {
    warn "Exception when calling UserApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userName = userName_example # String | user's name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.delete_user(userName, key)
except ApiException as e:
    print("Exception when calling UserApi->deleteUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userName = userName_example; // String
    let key = key_example; // String

    let mut context = UserApi::Context::default();
    let result = client.deleteUser(userName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userName*
String
user's name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

dup

Duplicate user's session, returns a new access key to the PKM.


/user/dup

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/dup"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            Object result = apiInstance.dup(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#dup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            Object result = apiInstance.dup(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#dup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance dupWith:key
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dup(key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dupExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                Object result = apiInstance.dup(key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.dup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->dup($key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->dup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->dup(key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->dup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.dup(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->dup: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let key = key_example; // String

    let mut context = UserApi::Context::default();
    let result = client.dup(key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getCurrentUser

Get current user


/user/current

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/current"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            PkmUser result = apiInstance.getCurrentUser(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            PkmUser result = apiInstance.getCurrentUser(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getCurrentUserWith:key
              completionHandler: ^(PkmUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrentUser(key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCurrentUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmUser result = apiInstance.getCurrentUser(key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getCurrentUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getCurrentUser($key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getCurrentUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getCurrentUser(key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getCurrentUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_current_user(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getCurrentUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let key = key_example; // String

    let mut context = UserApi::Context::default();
    let result = client.getCurrentUser(key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUser

Get user. WARNING! user can only view own Git user's credentials even if he's an administrator.


/user/{userName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/{userName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String key = key_example; // String | Access key to the PKM

        try {
            PkmUser result = apiInstance.getUser(userName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String key = key_example; // String | Access key to the PKM

        try {
            PkmUser result = apiInstance.getUser(userName, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userName = userName_example; // user's name (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getUserWith:userName
    key:key
              completionHandler: ^(PkmUser output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var userName = userName_example; // {String} user's name
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(userName, key, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userName = userName_example;  // String | user's name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                PkmUser result = apiInstance.getUser(userName, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userName = userName_example; // String | user's name
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getUser($userName, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userName = userName_example; # String | user's name
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getUser(userName => $userName, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userName = userName_example # String | user's name (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_user(userName, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userName = userName_example; // String
    let key = key_example; // String

    let mut context = UserApi::Context::default();
    let result = client.getUser(userName, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userName*
String
user's name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUserProject

Get a user project


/user/{userName}/project/{projectName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/{userName}/project/{projectName}?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String projectName = projectName_example; // String | project name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            PkmProject result = apiInstance.getUserProject(userName, projectName, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserProject");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String projectName = projectName_example; // String | project name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            PkmProject result = apiInstance.getUserProject(userName, projectName, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userName = userName_example; // user's name (default to null)
String *projectName = projectName_example; // project name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getUserProjectWith:userName
    projectName:projectName
    key:key
    abbrev:abbrev
              completionHandler: ^(PkmProject output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var userName = userName_example; // {String} user's name
var projectName = projectName_example; // {String} project name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserProject(userName, projectName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserProjectExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userName = userName_example;  // String | user's name (default to null)
            var projectName = projectName_example;  // String | project name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                PkmProject result = apiInstance.getUserProject(userName, projectName, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userName = userName_example; // String | user's name
$projectName = projectName_example; // String | project name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getUserProject($userName, $projectName, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userName = userName_example; # String | user's name
my $projectName = projectName_example; # String | project name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getUserProject(userName => $userName, projectName => $projectName, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userName = userName_example # String | user's name (default to null)
projectName = projectName_example # String | project name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_user_project(userName, projectName, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserProject: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userName = userName_example; // String
    let projectName = projectName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = UserApi::Context::default();
    let result = client.getUserProject(userName, projectName, key, abbrev, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userName*
String
user's name
Required
projectName*
String
project name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getUserProjects

Get user's projects


/user/{userName}/project

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/{userName}/project?abbrev=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            array[PkmProject] result = apiInstance.getUserProjects(userName, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserProjects");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userName = userName_example; // String | user's name
        String key = key_example; // String | Access key to the PKM
        Boolean abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

        try {
            array[PkmProject] result = apiInstance.getUserProjects(userName, key, abbrev);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserProjects");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userName = userName_example; // user's name (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *abbrev = true; // toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

[apiInstance getUserProjectsWith:userName
    key:key
    abbrev:abbrev
              completionHandler: ^(array[PkmProject] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var userName = userName_example; // {String} user's name
var key = key_example; // {String} Access key to the PKM
var opts = {
  'abbrev': true // {Boolean} toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserProjects(userName, key, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserProjectsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userName = userName_example;  // String | user's name (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var abbrev = true;  // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional)  (default to false)

            try {
                array[PkmProject] result = apiInstance.getUserProjects(userName, key, abbrev);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.getUserProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userName = userName_example; // String | user's name
$key = key_example; // String | Access key to the PKM
$abbrev = true; // Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

try {
    $result = $api_instance->getUserProjects($userName, $key, $abbrev);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userName = userName_example; # String | user's name
my $key = key_example; # String | Access key to the PKM
my $abbrev = true; # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

eval {
    my $result = $api_instance->getUserProjects(userName => $userName, key => $key, abbrev => $abbrev);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->getUserProjects: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userName = userName_example # String | user's name (default to null)
key = key_example # String | Access key to the PKM (default to null)
abbrev = true # Boolean | toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint (optional) (default to false)

try:
    api_response = api_instance.get_user_projects(userName, key, abbrev=abbrev)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->getUserProjects: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userName = userName_example; // String
    let key = key_example; // String
    let abbrev = true; // Boolean

    let mut context = UserApi::Context::default();
    let result = client.getUserProjects(userName, key, abbrev, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userName*
String
user's name
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
abbrev
Boolean
toggle abbreviated response (with only project name and members)/full response, useful for lowering response footprint

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

login

User's login, returns an access key to the PKM


/user/login

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/user/login" \
 -d '{
  "user_password" : "user_password",
  "user_name" : "user_name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        PkmLoginInfo body = ; // PkmLoginInfo | 

        try {
            Object result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#login");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        PkmLoginInfo body = ; // PkmLoginInfo | 

        try {
            Object result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#login");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
PkmLoginInfo *body = ; // 

[apiInstance loginWith:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var body = ; // {PkmLoginInfo} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var body = new PkmLoginInfo(); // PkmLoginInfo | 

            try {
                Object result = apiInstance.login(body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$body = ; // PkmLoginInfo | 

try {
    $result = $api_instance->login($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $body = WWW::OPenAPIClient::Object::PkmLoginInfo->new(); # PkmLoginInfo | 

eval {
    my $result = $api_instance->login(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->login: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
body =  # PkmLoginInfo | 

try:
    api_response = api_instance.login(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->login: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let body = ; // PkmLoginInfo

    let mut context = UserApi::Context::default();
    let result = client.login(body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

user's login informations

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

logout

User's logout, invalidates an access key to the PKM


/user/logout

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://pkm-api_pkm_1:8080/user/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.logout(key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#logout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM

        try {
            apiInstance.logout(key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#logout");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance logoutWith:key
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var key = key_example; // {String} Access key to the PKM

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.logout(key, 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()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                apiInstance.logout(key);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$key = key_example; // String | Access key to the PKM

try {
    $api_instance->logout($key);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $key = key_example; # String | Access key to the PKM

eval {
    $api_instance->logout(key => $key);
};
if ($@) {
    warn "Exception when calling UserApi->logout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
key = key_example # String | Access key to the PKM (default to null)

try:
    api_instance.logout(key)
except ApiException as e:
    print("Exception when calling UserApi->logout: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let key = key_example; // String

    let mut context = UserApi::Context::default();
    let result = client.logout(key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

postUser

Create a new user. WARNING! an administrator can set Git user's credentials at user creation but cannot alter them with later putUser operation.


/user

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/user" \
 -d '{
  "password" : "password",
  "phone" : "phone",
  "roles" : [ {
    "role" : "Owner",
    "db" : "db"
  }, {
    "role" : "Owner",
    "db" : "db"
  } ],
  "name" : "name",
  "git_user_credentials" : [ {
    "git_ssh_private_key" : "git_ssh_private_key",
    "git_user_name" : "git_user_name",
    "git_password" : "git_password",
    "git_remote_url" : "git_remote_url"
  }, {
    "git_ssh_private_key" : "git_ssh_private_key",
    "git_user_name" : "git_user_name",
    "git_password" : "git_password",
    "git_remote_url" : "git_remote_url"
  } ],
  "last_name" : "last_name",
  "first_name" : "first_name",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM
        PkmUser body = ; // PkmUser | 

        try {
            'String' result = apiInstance.postUser(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#postUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM
        PkmUser body = ; // PkmUser | 

        try {
            'String' result = apiInstance.postUser(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#postUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)
PkmUser *body = ; // 

[apiInstance postUserWith:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var key = key_example; // {String} Access key to the PKM
var body = ; // {PkmUser} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postUser(key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new PkmUser(); // PkmUser | 

            try {
                'String' result = apiInstance.postUser(key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.postUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$key = key_example; // String | Access key to the PKM
$body = ; // PkmUser | 

try {
    $result = $api_instance->postUser($key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->postUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::PkmUser->new(); # PkmUser | 

eval {
    my $result = $api_instance->postUser(key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->postUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
key = key_example # String | Access key to the PKM (default to null)
body =  # PkmUser | 

try:
    api_response = api_instance.post_user(key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->postUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let key = key_example; // String
    let body = ; // PkmUser

    let mut context = UserApi::Context::default();
    let result = client.postUser(key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

user's information

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

putUser

Update a user. WARNING! user can only change own Git user's credentials even if he's an administrator.


/user

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_pkm_1:8080/user" \
 -d '{
  "password" : "password",
  "phone" : "phone",
  "roles" : [ {
    "role" : "Owner",
    "db" : "db"
  }, {
    "role" : "Owner",
    "db" : "db"
  } ],
  "name" : "name",
  "git_user_credentials" : [ {
    "git_ssh_private_key" : "git_ssh_private_key",
    "git_user_name" : "git_user_name",
    "git_password" : "git_password",
    "git_remote_url" : "git_remote_url"
  }, {
    "git_ssh_private_key" : "git_ssh_private_key",
    "git_user_name" : "git_user_name",
    "git_password" : "git_password",
    "git_remote_url" : "git_remote_url"
  } ],
  "last_name" : "last_name",
  "first_name" : "first_name",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM
        PkmUser body = ; // PkmUser | 

        try {
            'String' result = apiInstance.putUser(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#putUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | Access key to the PKM
        PkmUser body = ; // PkmUser | 

        try {
            'String' result = apiInstance.putUser(key, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#putUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *key = key_example; // Access key to the PKM (default to null)
PkmUser *body = ; // 

[apiInstance putUserWith:key
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var PkmRestfulApi = require('pkm_restful_api');

// Create an instance of the API class
var api = new PkmRestfulApi.UserApi()
var key = key_example; // {String} Access key to the PKM
var body = ; // {PkmUser} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putUser(key, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new PkmUser(); // PkmUser | 

            try {
                'String' result = apiInstance.putUser(key, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.putUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$key = key_example; // String | Access key to the PKM
$body = ; // PkmUser | 

try {
    $result = $api_instance->putUser($key, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->putUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::PkmUser->new(); # PkmUser | 

eval {
    my $result = $api_instance->putUser(key => $key, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->putUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserApi()
key = key_example # String | Access key to the PKM (default to null)
body =  # PkmUser | 

try:
    api_response = api_instance.put_user(key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->putUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let key = key_example; // String
    let body = ; // PkmUser

    let mut context = UserApi::Context::default();
    let result = client.putUser(key, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

user's information

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String