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/