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
Name | Description |
---|---|
dbName* |
String
Database name
Required
|
artefactId* |
String
the ID of the annotation
Required
|
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 |