Skip to content

Latest commit

 

History

History
353 lines (247 loc) · 10.3 KB

CaseAnnotationsApi.md

File metadata and controls

353 lines (247 loc) · 10.3 KB
Raw

CaseAnnotationsApi

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

Method HTTP request Description
caseAnnotationsCreate POST /case_annotations/
caseAnnotationsDelete DELETE /case_annotations/{id}/
caseAnnotationsList GET /case_annotations/
caseAnnotationsPartialUpdate PATCH /case_annotations/{id}/
caseAnnotationsRead GET /case_annotations/{id}/
caseAnnotationsUpdate PUT /case_annotations/{id}/

caseAnnotationsCreate

CaseAnnotation caseAnnotationsCreate(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.CaseAnnotationsApi;

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");

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

Parameters

Name Type Description Notes
data CaseAnnotation

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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

caseAnnotationsDelete

caseAnnotationsDelete(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.CaseAnnotationsApi;

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");

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

Parameters

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

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

caseAnnotationsList

InlineResponse2001 caseAnnotationsList(belongsTo, label, 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.CaseAnnotationsApi;

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");

CaseAnnotationsApi apiInstance = new CaseAnnotationsApi();
BigDecimal belongsTo = new BigDecimal(); // BigDecimal | 
BigDecimal label = new BigDecimal(); // BigDecimal | 
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 {
    InlineResponse2001 result = apiInstance.caseAnnotationsList(belongsTo, label, limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CaseAnnotationsApi#caseAnnotationsList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
belongsTo BigDecimal [optional]
label BigDecimal [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

InlineResponse2001

Authorization

api_key

HTTP request headers

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

caseAnnotationsPartialUpdate

CaseAnnotation caseAnnotationsPartialUpdate(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.CaseAnnotationsApi;

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");

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

Parameters

Name Type Description Notes
id Integer A unique integer value identifying this case annotation.
data CaseAnnotation

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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

caseAnnotationsRead

CaseAnnotation caseAnnotationsRead(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.CaseAnnotationsApi;

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");

CaseAnnotationsApi apiInstance = new CaseAnnotationsApi();
Integer id = 56; // Integer | A unique integer value identifying this case annotation.
try {
    CaseAnnotation result = apiInstance.caseAnnotationsRead(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CaseAnnotationsApi#caseAnnotationsRead");
    e.printStackTrace();
}

Parameters

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

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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

caseAnnotationsUpdate

CaseAnnotation caseAnnotationsUpdate(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.CaseAnnotationsApi;

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");

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

Parameters

Name Type Description Notes
id Integer A unique integer value identifying this case annotation.
data CaseAnnotation

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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