Skip to main content

Distributions API

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

MethodHTTP requestDescription
distributionsCreateNewDistributionPOST /distributions/create/distributions/create [POST]
distributionsDeleteSpecificDistributionPOST /distributions/{distribution}/delete/distributions/{distribution}/delete [POST]
distributionsSnapshotGET /distributions/distributions [GET]

distributionsCreateNewDistribution

Distribution distributionsCreateNewDistribution(seededDistribution)

/distributions/create [POST]

This will create a new distribution.

Example

import 'package:core_openapi/api.dart';

final api_instance = DistributionsApi();
final seededDistribution = SeededDistribution(); // SeededDistribution |

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

Parameters

NameTypeDescriptionNotes
seededDistributionSeededDistribution[optional]

Return type

Distribution

Authorization

No authorization required

HTTP request headers

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

distributionsDeleteSpecificDistribution

distributionsDeleteSpecificDistribution(distribution)

/distributions/{distribution}/delete [POST]

This will delete a specific distribution.

Example

import 'package:core_openapi/api.dart';

final api_instance = DistributionsApi();
final distribution = distribution_example; // String | This is the uuid of a specific distribution.

try {
api_instance.distributionsDeleteSpecificDistribution(distribution);
} catch (e) {
print('Exception when calling DistributionsApi->distributionsDeleteSpecificDistribution: $e\n');
}

Parameters

NameTypeDescriptionNotes
distributionStringThis is the uuid of a specific distribution.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

distributionsSnapshot

Distributions distributionsSnapshot()

/distributions [GET]

This will get a specific snapshot of all our distributions.

Example

import 'package:core_openapi/api.dart';

final api_instance = DistributionsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

Distributions

Authorization

No authorization required

HTTP request headers

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