Skip to content

Latest commit

 

History

History
146 lines (96 loc) · 4.16 KB

AnnotationApi.md

File metadata and controls

146 lines (96 loc) · 4.16 KB
Raw

core_openapi.api.AnnotationApi

Load the API package

import 'package:pieces_os_client/api.dart';

All URIs are relative to http://localhost:3000

Method HTTP request Description
annotationScoresIncrement POST /annotation/{annotation}/scores/increment '/annotation/{annotation}/scores/increment' [POST]
annotationSpecificAnnotationSnapshot GET /annotation/{annotation} /annotation/{annotation} [GET]
annotationUpdate POST /annotation/update /annotation/update [POST]

annotationScoresIncrement

annotationScoresIncrement(annotation, seededScoreIncrement)

'/annotation/{annotation}/scores/increment' [POST]

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = AnnotationApi();
final annotation = annotation_example; // String | This is a specific annotation uuid.
final seededScoreIncrement = SeededScoreIncrement(); // SeededScoreIncrement | 

try {
    api_instance.annotationScoresIncrement(annotation, seededScoreIncrement);
} catch (e) {
    print('Exception when calling AnnotationApi->annotationScoresIncrement: $e\n');
}

Parameters

Name Type Description Notes
annotation String This is a specific annotation uuid.
seededScoreIncrement SeededScoreIncrement [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

annotationSpecificAnnotationSnapshot

Annotation annotationSpecificAnnotationSnapshot(annotation)

/annotation/{annotation} [GET]

This will get a snapshot of a specific annotation.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = AnnotationApi();
final annotation = annotation_example; // String | This is a specific annotation uuid.

try {
    final result = api_instance.annotationSpecificAnnotationSnapshot(annotation);
    print(result);
} catch (e) {
    print('Exception when calling AnnotationApi->annotationSpecificAnnotationSnapshot: $e\n');
}

Parameters

Name Type Description Notes
annotation String This is a specific annotation uuid.

Return type

Annotation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

annotationUpdate

Annotation annotationUpdate(annotation)

/annotation/update [POST]

This will update a specific annotation.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = AnnotationApi();
final annotation = Annotation(); // Annotation | 

try {
    final result = api_instance.annotationUpdate(annotation);
    print(result);
} catch (e) {
    print('Exception when calling AnnotationApi->annotationUpdate: $e\n');
}

Parameters

Name Type Description Notes
annotation Annotation [optional]

Return type

Annotation

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]