qase.api_client_v1.EnvironmentsApi

All URIs are relative to https://api.qase.io/v1

Method	HTTP request	Description
create_environment	POST /environment/{code}	Create a new environment
delete_environment	DELETE /environment/{code}/{id}	Delete environment
get_environment	GET /environment/{code}/{id}	Get a specific environment
get_environments	GET /environment/{code}	Get all environments
update_environment	PATCH /environment/{code}/{id}	Update environment

create_environment

IdResponse create_environment(code, environment_create)

Create a new environment

This method allows to create an environment in selected project.

Example

Api Key Authentication (TokenAuth):

import qase.api_client_v1
from qase.api_client_v1.models.environment_create import EnvironmentCreate
from qase.api_client_v1.models.id_response import IdResponse
from qase.api_client_v1.rest import ApiException
from pprint import pprint

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

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

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

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v1.EnvironmentsApi(api_client)
    code = 'code_example'  # str | Code of project, where to search entities.
    environment_create = qase.api_client_v1.EnvironmentCreate()  # EnvironmentCreate | 

    try:
        # Create a new environment
        api_response = api_instance.create_environment(code, environment_create)
        print("The response of EnvironmentsApi->create_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EnvironmentsApi->create_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
environment_create	EnvironmentCreate

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
422	Unprocessable Entity.	-
429	Too Many Requests.	-

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

delete_environment

IdResponse delete_environment(code, id)

Delete environment

This method completely deletes an environment from repository.

Example

Api Key Authentication (TokenAuth):

import qase.api_client_v1
from qase.api_client_v1.models.id_response import IdResponse
from qase.api_client_v1.rest import ApiException
from pprint import pprint

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

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

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

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v1.EnvironmentsApi(api_client)
    code = 'code_example'  # str | Code of project, where to search entities.
    id = 56  # int | Identifier.

    try:
        # Delete environment
        api_response = api_instance.delete_environment(code, id)
        print("The response of EnvironmentsApi->delete_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EnvironmentsApi->delete_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
id	int	Identifier.

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A Result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

get_environment

EnvironmentResponse get_environment(code, id)

Get a specific environment

This method allows to retrieve a specific environment.

Example

Api Key Authentication (TokenAuth):

import qase.api_client_v1
from qase.api_client_v1.models.environment_response import EnvironmentResponse
from qase.api_client_v1.rest import ApiException
from pprint import pprint

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

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

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

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v1.EnvironmentsApi(api_client)
    code = 'code_example'  # str | Code of project, where to search entities.
    id = 56  # int | Identifier.

    try:
        # Get a specific environment
        api_response = api_instance.get_environment(code, id)
        print("The response of EnvironmentsApi->get_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EnvironmentsApi->get_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
id	int	Identifier.

Return type

EnvironmentResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	An environment.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

get_environments

EnvironmentListResponse get_environments(code, search=search, slug=slug, limit=limit, offset=offset)

Get all environments

This method allows to retrieve all environments stored in selected project.

Example

Api Key Authentication (TokenAuth):

import qase.api_client_v1
from qase.api_client_v1.models.environment_list_response import EnvironmentListResponse
from qase.api_client_v1.rest import ApiException
from pprint import pprint

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

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

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

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v1.EnvironmentsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    search = 'search_example' # str | A search string. Will return all environments with titles containing provided string.  (optional)
    slug = 'slug_example' # str | A search string.  Will return all environments with slugs equal to provided string.  (optional)
    limit = 10 # int | A number of entities in result set. (optional) (default to 10)
    offset = 0 # int | How many entities should be skipped. (optional) (default to 0)

    try:
        # Get all environments
        api_response = api_instance.get_environments(code, search=search, slug=slug, limit=limit, offset=offset)
        print("The response of EnvironmentsApi->get_environments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EnvironmentsApi->get_environments: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
search	str	A search string. Will return all environments with titles containing provided string.	[optional]
slug	str	A search string. Will return all environments with slugs equal to provided string.	[optional]
limit	int	A number of entities in result set.	[optional] [default to 10]
offset	int	How many entities should be skipped.	[optional] [default to 0]

Return type

EnvironmentListResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of all environments.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

update_environment

IdResponse update_environment(code, id, environment_update)

Update environment

This method updates an environment.

Example

Api Key Authentication (TokenAuth):

import qase.api_client_v1
from qase.api_client_v1.models.environment_update import EnvironmentUpdate
from qase.api_client_v1.models.id_response import IdResponse
from qase.api_client_v1.rest import ApiException
from pprint import pprint

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

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

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

# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v1.EnvironmentsApi(api_client)
    code = 'code_example'  # str | Code of project, where to search entities.
    id = 56  # int | Identifier.
    environment_update = qase.api_client_v1.EnvironmentUpdate()  # EnvironmentUpdate | 

    try:
        # Update environment
        api_response = api_instance.update_environment(code, id, environment_update)
        print("The response of EnvironmentsApi->update_environment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EnvironmentsApi->update_environment: %s\n" % e)

Parameters

Name	Type	Description
code	str	Code of project, where to search entities.
id	int	Identifier.
environment_update	EnvironmentUpdate

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

Files

EnvironmentsApi.md

Latest commit

History

EnvironmentsApi.md

File metadata and controls

qase.api_client_v1.EnvironmentsApi

create_environment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_environment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_environment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_environments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_environment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details