Skip to content

Latest commit

 

History

History
427 lines (297 loc) · 13.4 KB

ResourceApi.md

File metadata and controls

427 lines (297 loc) · 13.4 KB

sparkworks_client.ResourceApi

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

Method HTTP request Description
count_resources GET /v2/resource/count Count Resources
create_resource POST /v2/resource Create a new Resource
delete_resource DELETE /v2/resource/{uuid} Delete Resource by its UUID
get_resource_by_uuid GET /v2/resource/{uuid} Retrieve a Spark Works Resource by its UUID
get_resources GET /v2/resource Retrieve a collection of Resources
move_resource POST /v2/resource/{uuid}/move/{targetUUID} Move Resource by its UUID
query_resources POST /v2/resource/query Retrieve a Resource by a query
update_resource POST /v2/resource/{uuid} Update Resource

count_resources

int count_resources()

Count Resources

A Spark Works Accounts authenticated common user is able to retrieve the number of Resources that has permissions on. An administrator is able to retrieve the number of all Resources.

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.ResourceApi(sparkworks_client.ApiClient(configuration))

try:
    # Count Resources
    api_response = api_instance.count_resources()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceApi->count_resources: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

int

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

create_resource

ResourceDTO create_resource(resource_create_dto)

Create a new Resource

A Spark Works authenticated user is able to request a new Resource creation

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.ResourceApi(sparkworks_client.ApiClient(configuration))
resource_create_dto = sparkworks_client.ResourceCreateDTO() # ResourceCreateDTO | Resource Creation API Model

try:
    # Create a new Resource
    api_response = api_instance.create_resource(resource_create_dto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceApi->create_resource: %s\n" % e)

Parameters

Name Type Description Notes
resource_create_dto ResourceCreateDTO Resource Creation API Model

Return type

ResourceDTO

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_resource

delete_resource(uuid)

Delete Resource by its UUID

A Spark Works Accounts authenticated common user is able to remove a Spark Works Resource that has permissions on by its unique identifier. An administrator is able to remove any Resource of the platform

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.ResourceApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Resource UUID

try:
    # Delete Resource by its UUID
    api_instance.delete_resource(uuid)
except ApiException as e:
    print("Exception when calling ResourceApi->delete_resource: %s\n" % e)

Parameters

Name Type Description Notes
uuid str The Resource 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_resource_by_uuid

ResourceDTO get_resource_by_uuid(uuid)

Retrieve a Spark Works Resource by its UUID

A Spark Works Accounts authenticated common user is able to retrieve a Resource, that has permissions on, by its UUID. An administrator is able to retrieve any Resource of the platform

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.ResourceApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Resource UUID

try:
    # Retrieve a Spark Works Resource by its UUID
    api_response = api_instance.get_resource_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceApi->get_resource_by_uuid: %s\n" % e)

Parameters

Name Type Description Notes
uuid str The Resource UUID

Return type

ResourceDTO

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_resources

list[ResourceDTO] get_resources()

Retrieve a collection of Resources

A Spark Works Accounts authenticated common user is able to retrieve all of the Platform resources that the user has permissions on. An administrator is able to query all of the platform resources

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.ResourceApi(sparkworks_client.ApiClient(configuration))

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

Parameters

This endpoint does not need any parameter.

Return type

list[ResourceDTO]

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

move_resource

ResourceDTO move_resource(uuid, target_uuid)

Move Resource by its UUID

A Spark Works Accounts authenticated common user is able to move a Spark Works Resource that has permissions on by its unique identifierto a Spark Works Group that has permissions on. An administrator is able to move any Resource of the platform

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.ResourceApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Resource UUID
target_uuid = 'target_uuid_example' # str | The Group UUID

try:
    # Move Resource by its UUID
    api_response = api_instance.move_resource(uuid, target_uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceApi->move_resource: %s\n" % e)

Parameters

Name Type Description Notes
uuid str The Resource UUID
target_uuid str The Group UUID

Return type

ResourceDTO

Authorization

oauth2

HTTP request headers

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

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

query_resources

ResourceDTO query_resources(resource_query_dto)

Retrieve a Resource by a query

A Spark Works Accounts authenticated common user is able to retrieve a Resource that has permissions on by a query object. An administrator is able to get any Resource by a query object.

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.ResourceApi(sparkworks_client.ApiClient(configuration))
resource_query_dto = sparkworks_client.ResourceQueryDTO() # ResourceQueryDTO | The Resource Query

try:
    # Retrieve a Resource by a query
    api_response = api_instance.query_resources(resource_query_dto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceApi->query_resources: %s\n" % e)

Parameters

Name Type Description Notes
resource_query_dto ResourceQueryDTO The Resource Query

Return type

ResourceDTO

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_resource

ResourceDTO update_resource(uuid, resource_update_dto)

Update Resource

A Spark Works Accounts authenticated common user is able to update a Resource's values that has permission on. An administrator is able to update the values of any Resource.

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.ResourceApi(sparkworks_client.ApiClient(configuration))
uuid = 'uuid_example' # str | The Group UUID
resource_update_dto = sparkworks_client.ResourceUpdateDTO() # ResourceUpdateDTO | resourceUpdateDTO

try:
    # Update Resource
    api_response = api_instance.update_resource(uuid, resource_update_dto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceApi->update_resource: %s\n" % e)

Parameters

Name Type Description Notes
uuid str The Group UUID
resource_update_dto ResourceUpdateDTO resourceUpdateDTO

Return type

ResourceDTO

Authorization

oauth2

HTTP request headers

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

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