Skip to main content

WorkstreamEvents API

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

MethodHTTP requestDescription
workstreamEventsCreateNewWorkstreamEventPOST /workstream_events/create/workstream_events/create [POST]
workstreamEventsDeleteSpecificWorkstreamEventPOST /workstream_events/{workstream_event}/delete/workstream_events/{workstream_event}/delete [POST]
workstreamEventsSnapshotGET /workstream_events/workstream_events [GET]

workstreamEventsCreateNewWorkstreamEvent

WorkstreamEvent workstreamEventsCreateNewWorkstreamEvent(transferables, seededWorkstreamEvent)

/workstream_events/create [POST]

This will create a new WorkstreamEvent in the database.

Example

import 'package:core_openapi/api.dart';

final api_instance = WorkstreamEventsApi();
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 seededWorkstreamEvent = SeededWorkstreamEvent(); // SeededWorkstreamEvent |

try {
final result = api_instance.workstreamEventsCreateNewWorkstreamEvent(transferables, seededWorkstreamEvent);
print(result);
} catch (e) {
print('Exception when calling WorkstreamEventsApi->workstreamEventsCreateNewWorkstreamEvent: $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]
seededWorkstreamEventSeededWorkstreamEvent[optional]

Return type

WorkstreamEvent

Authorization

No authorization required

HTTP request headers

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

workstreamEventsDeleteSpecificWorkstreamEvent

workstreamEventsDeleteSpecificWorkstreamEvent(workstreamEvent)

/workstream_events/{workstream_event}/delete [POST]

This will delete a specific workstream_event from the database!

Example

import 'package:core_openapi/api.dart';

final api_instance = WorkstreamEventsApi();
final workstreamEvent = workstreamEvent_example; // String | This is a identifier that is used to identify a specific workstream_event.

try {
api_instance.workstreamEventsDeleteSpecificWorkstreamEvent(workstreamEvent);
} catch (e) {
print('Exception when calling WorkstreamEventsApi->workstreamEventsDeleteSpecificWorkstreamEvent: $e\n');
}

Parameters

NameTypeDescriptionNotes
workstreamEventStringThis is a identifier that is used to identify a specific workstream_event.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamEventsSnapshot

WorkstreamEvents workstreamEventsSnapshot(transferables)

/workstream_events [GET]

This will get a snapshot of all your workstream events.

Example

import 'package:core_openapi/api.dart';

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

WorkstreamEvents

Authorization

No authorization required

HTTP request headers

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