TeamsApi.md

epiccore.TeamsApi

All URIs are relative to https://epic.zenotech.com/api/v2

Method	HTTP request	Description
teams_list	GET /teams/
teams_read	GET /teams/{id}/

teams_list

TeamsList200Response teams_list(name=name, role=role, limit=limit, offset=offset)

List the teams you are a member of.

Example

• Api Key Authentication (Bearer):

import time
import os
import epiccore
from epiccore.models.teams_list200_response import TeamsList200Response
from epiccore.rest import ApiException
from pprint import pprint

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

# 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: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.TeamsApi(api_client)
    name = 'name_example' # str |  (optional)
    role = 'role_example' # str |  (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)

    try:
        api_response = api_instance.teams_list(name=name, role=role, limit=limit, offset=offset)
        print("The response of TeamsApi->teams_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamsApi->teams_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str		[optional]
role	str		[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]

Return type

TeamsList200Response

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

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

teams_read

TeamDetails teams_read(id)

See the details for a team. You must be a member of the team to see the details.

Example

• Api Key Authentication (Bearer):

import time
import os
import epiccore
from epiccore.models.team_details import TeamDetails
from epiccore.rest import ApiException
from pprint import pprint

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

# 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: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.TeamsApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.teams_read(id)
        print("The response of TeamsApi->teams_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamsApi->teams_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

TeamDetails

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

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