Skip to main content

WorkstreamEvent API

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

MethodHTTP requestDescription
workstream_event_associate_workstream_summaryPOST /workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary}/workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary} [POST]
workstream_event_disassociate_workstream_summaryPOST /workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary}/workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary} [POST]
workstream_event_scores_incrementPOST /workstream_event/{workstream_event}/scores/increment'/workstream_event/{workstream_event}/scores/increment' [POST]
workstream_event_updatePOST /workstream_event/update/workstream_event/update [POST]
workstream_events_specific_workstream_event_snapshotGET /workstream_event/{workstream_event}/workstream_event/{workstream_event} [GET]

workstream_event_associate_workstream_summary

workstream_event_associate_workstream_summary(workstream_event, workstream_summary)

/workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary} [POST]

This will associate a workstream_event with a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.WorkstreamEventApi(api_client)
workstream_event = 'workstream_event_example' # str | This is a identifier that is used to identify a specific workstream_event.
workstream_summary = 'workstream_summary_example' # str | This is a identifier that is used to identify a specific workstream_summary.

try:
# /workstream_event/\{workstream_event\}/workstream_summaries/associate/\{workstream_summary\} [POST]
api_instance.workstream_event_associate_workstream_summary(workstream_event, workstream_summary)
except Exception as e:
print("Exception when calling WorkstreamEventApi->workstream_event_associate_workstream_summary: %s\n" % e)

Parameters

NameTypeDescriptionNotes
workstream_eventstrThis is a identifier that is used to identify a specific workstream_event.
workstream_summarystrThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

workstream_event_disassociate_workstream_summary

workstream_event_disassociate_workstream_summary(workstream_event, workstream_summary)

/workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary} [POST]

This will enable us to disassociate a workstream_event from a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import pieces_os_client
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.WorkstreamEventApi(api_client)
workstream_event = 'workstream_event_example' # str | This is a identifier that is used to identify a specific workstream_event.
workstream_summary = 'workstream_summary_example' # str | This is a identifier that is used to identify a specific workstream_summary.

try:
# /workstream_event/\{workstream_event\}/workstream_summaries/disassociate/\{workstream_summary\} [POST]
api_instance.workstream_event_disassociate_workstream_summary(workstream_event, workstream_summary)
except Exception as e:
print("Exception when calling WorkstreamEventApi->workstream_event_disassociate_workstream_summary: %s\n" % e)

Parameters

NameTypeDescriptionNotes
workstream_eventstrThis is a identifier that is used to identify a specific workstream_event.
workstream_summarystrThis is a identifier that is used to identify a specific workstream_summary.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

workstream_event_scores_increment

workstream_event_scores_increment(workstream_event, seeded_score_increment=seeded_score_increment)

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

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

Example

import pieces_os_client
from pieces_os_client.models.seeded_score_increment import SeededScoreIncrement
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.WorkstreamEventApi(api_client)
workstream_event = 'workstream_event_example' # str | This is a identifier that is used to identify a specific workstream_event.
seeded_score_increment = pieces_os_client.SeededScoreIncrement() # SeededScoreIncrement | (optional)

try:
# '/workstream_event/\{workstream_event\}/scores/increment' [POST]
api_instance.workstream_event_scores_increment(workstream_event, seeded_score_increment=seeded_score_increment)
except Exception as e:
print("Exception when calling WorkstreamEventApi->workstream_event_scores_increment: %s\n" % e)

Parameters

NameTypeDescriptionNotes
workstream_eventstrThis is a identifier that is used to identify a specific workstream_event.
seeded_score_incrementSeededScoreIncrement[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

workstream_event_update

WorkstreamEvent workstream_event_update(transferables=transferables, workstream_event=workstream_event)

/workstream_event/update [POST]

This will update a specific workstream_event.

Example

import pieces_os_client
from pieces_os_client.models.workstream_event import WorkstreamEvent
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.WorkstreamEventApi(api_client)
transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
workstream_event = pieces_os_client.WorkstreamEvent() # WorkstreamEvent | (optional)

try:
# /workstream_event/update [POST]
api_response = api_instance.workstream_event_update(transferables=transferables, workstream_event=workstream_event)
print("The response of WorkstreamEventApi->workstream_event_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WorkstreamEventApi->workstream_event_update: %s\n" % e)

Parameters

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

Return type

WorkstreamEvent

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

workstream_events_specific_workstream_event_snapshot

WorkstreamEvent workstream_events_specific_workstream_event_snapshot(workstream_event, transferables=transferables)

/workstream_event/{workstream_event} [GET]

This will get a snapshot of a single workstream_event.

Example

import pieces_os_client
from pieces_os_client.models.workstream_event import WorkstreamEvent
from pieces_os_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1000
# See configuration.py for a list of all supported configuration parameters.
configuration = pieces_os_client.Configuration(
host="http://localhost:1000"
)


# Enter a context with an instance of the API client
with pieces_os_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pieces_os_client.WorkstreamEventApi(api_client)
workstream_event = 'workstream_event_example' # str | This is a identifier that is used to identify a specific workstream_event.
transferables = True # bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)

try:
# /workstream_event/\{workstream_event\} [GET]
api_response = api_instance.workstream_events_specific_workstream_event_snapshot(workstream_event, transferables=transferables)
print("The response of WorkstreamEventApi->workstream_events_specific_workstream_event_snapshot:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WorkstreamEventApi->workstream_events_specific_workstream_event_snapshot: %s\n" % e)

Parameters

NameTypeDescriptionNotes
workstream_eventstrThis is a identifier that is used to identify a specific workstream_event.
transferablesboolThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]

Return type

WorkstreamEvent

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
410WorkstreamEvent not found.-