Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 3.16 KB

FormatsApi.md

File metadata and controls

103 lines (68 loc) · 3.16 KB
Raw

core_openapi.api.FormatsApi

Load the API package

import 'package:pieces_os_client/api.dart';

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

Method HTTP request Description
formatsSnapshot GET /formats /formats [GET] Scoped to Formats
formatsSpecificFormatSnapshot GET /formats/{format} /formats/{format} [GET] Scoped to Formats

formatsSnapshot

Formats formatsSnapshot(transferables)

/formats [GET] Scoped to Formats

Get all of your formats for a given user.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = FormatsApi();
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.formatsSnapshot(transferables);
    print(result);
} catch (e) {
    print('Exception when calling FormatsApi->formatsSnapshot: $e\n');
}

Parameters

Name Type Description Notes
transferables bool This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) [optional]

Return type

Formats

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]

formatsSpecificFormatSnapshot

Format formatsSpecificFormatSnapshot(format, transferable)

/formats/{format} [GET] Scoped to Formats

Request a specific format when given a id (uuid in path params)

Example

import 'package:pieces_os_client/api.dart';

final api_instance = FormatsApi();
final format = 102ff265-fdfb-4142-8d94-4932d400199c; // String | The id (uuid) for a specific format.
final transferable = 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.formatsSpecificFormatSnapshot(format, transferable);
    print(result);
} catch (e) {
    print('Exception when calling FormatsApi->formatsSpecificFormatSnapshot: $e\n');
}

Parameters

Name Type Description Notes
format String The id (uuid) for a specific format.
transferable bool This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) [optional]

Return type

Format

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]