Skip to content

Latest commit

 

History

History
executable file
·
245 lines (181 loc) · 7.38 KB

ProjectsApi.md

File metadata and controls

executable file
·
245 lines (181 loc) · 7.38 KB
Raw

epiccore.ProjectsApi

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

Method HTTP request Description
projects_list GET /projects/
projects_partial_update PATCH /projects/{id}/
projects_read GET /projects/{id}/

projects_list

InlineResponse20010 projects_list(name=name, limit=limit, offset=offset)

List the projects you have access to

Example

  • Api Key Authentication (Bearer):
from __future__ import print_function
import time
import epiccore
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 = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2",
    api_key = {
        'Bearer': 'YOUR_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.ProjectsApi(api_client)
    name = 'name_example' # str | Filter by project name (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.projects_list(name=name, limit=limit, offset=offset)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProjectsApi->projects_list: %s\n" % e)

Parameters

Name Type Description Notes
name str Filter by project name [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

InlineResponse20010

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]

projects_partial_update

Project projects_partial_update(id, data)

Update the project description or open/close a project.

Example

  • Api Key Authentication (Bearer):
from __future__ import print_function
import time
import epiccore
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 = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2",
    api_key = {
        'Bearer': 'YOUR_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.ProjectsApi(api_client)
    id = 'id_example' # str | 
data = epiccore.Project() # Project | 

    try:
        api_response = api_instance.projects_partial_update(id, data)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProjectsApi->projects_partial_update: %s\n" % e)

Parameters

Name Type Description Notes
id str
data Project

Return type

Project

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • 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]

projects_read

ProjectDetails projects_read(id)

See the details for a project.

Example

  • Api Key Authentication (Bearer):
from __future__ import print_function
import time
import epiccore
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 = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2",
    api_key = {
        'Bearer': 'YOUR_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.ProjectsApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.projects_read(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProjectsApi->projects_read: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ProjectDetails

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]