Skip to content

Latest commit

 

History

History
359 lines (253 loc) · 10.7 KB

AnnotationLabelsApi.md

File metadata and controls

359 lines (253 loc) · 10.7 KB
Raw

AnnotationLabelsApi

All URIs are relative to https://de.openlegaldata.io/api

Method HTTP request Description
annotationLabelsCreate POST /annotation_labels/
annotationLabelsDelete DELETE /annotation_labels/{id}/
annotationLabelsList GET /annotation_labels/
annotationLabelsPartialUpdate PATCH /annotation_labels/{id}/
annotationLabelsRead GET /annotation_labels/{id}/
annotationLabelsUpdate PUT /annotation_labels/{id}/

annotationLabelsCreate

AnnotationLabel annotationLabelsCreate(data)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.AnnotationLabelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

AnnotationLabelsApi apiInstance = new AnnotationLabelsApi();
AnnotationLabel data = new AnnotationLabel(); // AnnotationLabel | 
try {
    AnnotationLabel result = apiInstance.annotationLabelsCreate(data);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnotationLabelsApi#annotationLabelsCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
data AnnotationLabel

Return type

AnnotationLabel

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

annotationLabelsDelete

annotationLabelsDelete(id)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.AnnotationLabelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

AnnotationLabelsApi apiInstance = new AnnotationLabelsApi();
Integer id = 56; // Integer | A unique integer value identifying this Label.
try {
    apiInstance.annotationLabelsDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnotationLabelsApi#annotationLabelsDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer A unique integer value identifying this Label.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

annotationLabelsList

InlineResponse200 annotationLabelsList(ordering, owner, slug, _private, trusted, limit, offset)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.AnnotationLabelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

AnnotationLabelsApi apiInstance = new AnnotationLabelsApi();
String ordering = "ordering_example"; // String | Which field to use when ordering the results.
BigDecimal owner = new BigDecimal(); // BigDecimal | 
String slug = "slug_example"; // String | 
String _private = "_private_example"; // String | 
String trusted = "trusted_example"; // String | 
Integer limit = 56; // Integer | Number of results to return per page.
Integer offset = 56; // Integer | The initial index from which to return the results.
try {
    InlineResponse200 result = apiInstance.annotationLabelsList(ordering, owner, slug, _private, trusted, limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnotationLabelsApi#annotationLabelsList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
owner BigDecimal [optional]
slug String [optional]
_private String [optional]
trusted String [optional]
limit Integer Number of results to return per page. [optional]
offset Integer The initial index from which to return the results. [optional]

Return type

InlineResponse200

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

annotationLabelsPartialUpdate

AnnotationLabel annotationLabelsPartialUpdate(id, data)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.AnnotationLabelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

AnnotationLabelsApi apiInstance = new AnnotationLabelsApi();
Integer id = 56; // Integer | A unique integer value identifying this Label.
AnnotationLabel data = new AnnotationLabel(); // AnnotationLabel | 
try {
    AnnotationLabel result = apiInstance.annotationLabelsPartialUpdate(id, data);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnotationLabelsApi#annotationLabelsPartialUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer A unique integer value identifying this Label.
data AnnotationLabel

Return type

AnnotationLabel

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

annotationLabelsRead

AnnotationLabel annotationLabelsRead(id)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.AnnotationLabelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

AnnotationLabelsApi apiInstance = new AnnotationLabelsApi();
Integer id = 56; // Integer | A unique integer value identifying this Label.
try {
    AnnotationLabel result = apiInstance.annotationLabelsRead(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnotationLabelsApi#annotationLabelsRead");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer A unique integer value identifying this Label.

Return type

AnnotationLabel

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

annotationLabelsUpdate

AnnotationLabel annotationLabelsUpdate(id, data)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.AnnotationLabelsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

AnnotationLabelsApi apiInstance = new AnnotationLabelsApi();
Integer id = 56; // Integer | A unique integer value identifying this Label.
AnnotationLabel data = new AnnotationLabel(); // AnnotationLabel | 
try {
    AnnotationLabel result = apiInstance.annotationLabelsUpdate(id, data);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnotationLabelsApi#annotationLabelsUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer A unique integer value identifying this Label.
data AnnotationLabel

Return type

AnnotationLabel

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json