Skip to main content

Tags API

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

MethodHTTP requestDescription
tagsCreateNewTagPOST /tags/create/tags/create [POST]
tagsDeleteSpecificTagPOST /tags/{tag}/delete/tags/{tag}/delete [POST]
tagsExistsPOST /tags/exists/tags/exists [POST]
tagsSnapshotGET /tags/tags [GET]

tagsCreateNewTag

Tag tagsCreateNewTag(transferables, seededTag)

/tags/create [POST]

This will create a new tag.

Example

import 'package:core_openapi/api.dart';

final api_instance = TagsApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
final seededTag = SeededTag(); // SeededTag |

try {
final result = api_instance.tagsCreateNewTag(transferables, seededTag);
print(result);
} catch (e) {
print('Exception when calling TagsApi->tagsCreateNewTag: $e\n');
}

Parameters

NameTypeDescriptionNotes
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]
seededTagSeededTag[optional]

Return type

Tag

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

tagsDeleteSpecificTag

tagsDeleteSpecificTag(tag)

/tags/{tag}/delete [POST]

This will delete a specific tag.

Example

import 'package:core_openapi/api.dart';

final api_instance = TagsApi();
final tag = tag_example; // String | tag id

try {
api_instance.tagsDeleteSpecificTag(tag);
} catch (e) {
print('Exception when calling TagsApi->tagsDeleteSpecificTag: $e\n');
}

Parameters

NameTypeDescriptionNotes
tagStringtag id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

tagsExists

ExistingMetadata tagsExists(existentMetadata)

/tags/exists [POST]

This will check all of the tags in our database to see if this specific provided tag actually exists, if not we will just return a null tag in the output.

Example

import 'package:core_openapi/api.dart';

final api_instance = TagsApi();
final existentMetadata = ExistentMetadata(); // ExistentMetadata |

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

Parameters

NameTypeDescriptionNotes
existentMetadataExistentMetadata[optional]

Return type

ExistingMetadata

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

tagsSnapshot

Tags tagsSnapshot(transferables)

/tags [GET]

This will get a snapshot of all of your tags.

Example

import 'package:core_openapi/api.dart';

final api_instance = TagsApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)

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

Parameters

NameTypeDescriptionNotes
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]

Return type

Tags

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain