TaskApi.md

gridly.TaskApi

All URIs are relative to https://api.gridly.com

Method	HTTP request	Description
get	GET /v1/tasks/{taskId}	get

get

Task get(task_id)

get

get

Example

• Api Key Authentication (ApiKey):

import gridly
from gridly.models.task import Task
from gridly.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.gridly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = gridly.Configuration(
    host = "https://api.gridly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with gridly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gridly.TaskApi(api_client)
    task_id = 'task_id_example' # str | taskId

    try:
        # get
        api_response = api_instance.get(task_id)
        print("The response of TaskApi->get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TaskApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_id	str	taskId

Return type

Task

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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