sparkworks_client.UnitApi

All URIs are relative to https://api.sparkworks.net

Method	HTTP request	Description
create_unit	POST /v2/unit	Create a Unit
delete_unit	DELETE /v2/unit/{uuid}	Delete a Unit by its UUID
get_all_units	GET /v2/unit	Retrieve a collection of Units
get_unit_by_uuid	GET /v2/unit/{uuid}	Retrieve a Unit by its UUID
query_units	POST /v2/unit/query	Retrieve a Unit by a query
update_unit	POST /v2/unit/{uuid}	Update Unit

create_unit

UnitDTO create_unit(unit_create_dto)

Create a Unit

A Spark Works Accounts authenticated user is able to create a Unit.

Example

from __future__ import print_function
import time
import sparkworks_client
from sparkworks_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = sparkworks_client.Configuration("username", "password", "client_id", "client_secret")
configuration.connect()

# create an instance of the API class
api_instance = sparkworks_client.UnitApi(sparkworks_client.ApiClient(configuration))
unit_create_dto = sparkworks_client.UnitCreateDTO() # UnitCreateDTO | Unit Creation API Model

try:
    # Create a Unit
    api_response = api_instance.create_unit(unit_create_dto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitApi->create_unit: %s\n" % e)

Parameters

Name	Type	Description	Notes
unit_create_dto	UnitCreateDTO	Unit Creation API Model

Return type

UnitDTO

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_unit

delete_unit(uuid)

Delete a Unit by its UUID

A Spark Works Accounts authenticated user is able to delete a Unit by its UUID.

Example

from __future__ import print_function
import time
import sparkworks_client
from sparkworks_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = sparkworks_client.Configuration("username", "password", "client_id", "client_secret")
configuration.connect()

# create an instance of the API class
api_instance = sparkworks_client.UnitApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Unit UUID

try:
    # Delete a Unit by its UUID
    api_instance.delete_unit(uuid)
except ApiException as e:
    print("Exception when calling UnitApi->delete_unit: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str	The Unit UUID

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_units

list[UnitDTO] get_all_units()

Retrieve a collection of Units

A Spark Works Accounts authenticated user is able to retrieve all of the Platform Units.

Example

from __future__ import print_function
import time
import sparkworks_client
from sparkworks_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = sparkworks_client.Configuration("username", "password", "client_id", "client_secret")
configuration.connect()

# create an instance of the API class
api_instance = sparkworks_client.UnitApi(sparkworks_client.ApiClient(configuration))

try:
    # Retrieve a collection of Units
    api_response = api_instance.get_all_units()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitApi->get_all_units: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[UnitDTO]

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_unit_by_uuid

UnitDTO get_unit_by_uuid(uuid)

Retrieve a Unit by its UUID

A Spark Works Accounts authenticated common user is able to retrieve a Unit that has permissions on by its UUID. An administrator is able to get any Unit by its UUID.

Example

from __future__ import print_function
import time
import sparkworks_client
from sparkworks_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = sparkworks_client.Configuration("username", "password", "client_id", "client_secret")
configuration.connect()

# create an instance of the API class
api_instance = sparkworks_client.UnitApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Unit UUID

try:
    # Retrieve a Unit by its UUID
    api_response = api_instance.get_unit_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitApi->get_unit_by_uuid: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str	The Unit UUID

Return type

UnitDTO

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

query_units

UnitDTO query_units(unit_query_dto)

Retrieve a Unit by a query

A Spark Works Accounts authenticated user is able to retrieve a Unit.

Example

from __future__ import print_function
import time
import sparkworks_client
from sparkworks_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = sparkworks_client.Configuration("username", "password", "client_id", "client_secret")
configuration.connect()

# create an instance of the API class
api_instance = sparkworks_client.UnitApi(sparkworks_client.ApiClient(configuration))
unit_query_dto = sparkworks_client.UnitQueryDTO() # UnitQueryDTO | Unit Query API Model

try:
    # Retrieve a Unit by a query
    api_response = api_instance.query_units(unit_query_dto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitApi->query_units: %s\n" % e)

Parameters

Name	Type	Description	Notes
unit_query_dto	UnitQueryDTO	Unit Query API Model

Return type

UnitDTO

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_unit

UnitDTO update_unit(uuid, update_dto)

Update Unit

A Spark Works Accounts administrator is able to update a Unit by its UUID.

Example

from __future__ import print_function
import time
import sparkworks_client
from sparkworks_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = sparkworks_client.Configuration("username", "password", "client_id", "client_secret")
configuration.connect()

# create an instance of the API class
api_instance = sparkworks_client.UnitApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Unit UUID
update_dto = sparkworks_client.UnitUpdateDTO() # UnitUpdateDTO | updateDTO

try:
    # Update Unit
    api_response = api_instance.update_unit(uuid, update_dto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnitApi->update_unit: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str	The Unit UUID
update_dto	UnitUpdateDTO	updateDTO

Return type

UnitDTO

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]