qaseio.PlansApi

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

Method	HTTP request	Description
create_plan	POST /plan/{code}	Create a new plan.
delete_plan	DELETE /plan/{code}/{id}	Delete plan.
get_plan	GET /plan/{code}/{id}	Get a specific plan.
get_plans	GET /plan/{code}	Get all plans.
update_plan	PATCH /plan/{code}/{id}	Update plan.

create_plan

IdResponse create_plan(code, plan_create)

Create a new plan.

This method allows to create a plan in selected project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.id_response import IdResponse
from qaseio.models.plan_create import PlanCreate
from qaseio.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 = qaseio.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 qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.PlansApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    plan_create = qaseio.PlanCreate() # PlanCreate | 

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

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
plan_create	PlanCreate

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_plan

IdResponse delete_plan(code, id)

Delete plan.

This method completely deletes a plan from repository.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.id_response import IdResponse
from qaseio.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 = qaseio.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 qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.PlansApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.

    try:
        # Delete plan.
        api_response = api_instance.delete_plan(code, id)
        print("The response of PlansApi->delete_plan:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->delete_plan: %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_plan

PlanResponse get_plan(code, id)

Get a specific plan.

This method allows to retrieve a specific plan.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.plan_response import PlanResponse
from qaseio.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 = qaseio.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 qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.PlansApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.

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

Parameters

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

Return type

PlanResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A plan.	-
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_plans

PlanListResponse get_plans(code, limit=limit, offset=offset)

Get all plans.

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

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.plan_list_response import PlanListResponse
from qaseio.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 = qaseio.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 qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.PlansApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    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 plans.
        api_response = api_instance.get_plans(code, limit=limit, offset=offset)
        print("The response of PlansApi->get_plans:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->get_plans: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
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

PlanListResponse

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 plans.	-
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_plan

IdResponse update_plan(code, id, plan_update)

Update plan.

This method updates a plan.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.id_response import IdResponse
from qaseio.models.plan_update import PlanUpdate
from qaseio.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 = qaseio.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 qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.PlansApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.
    plan_update = qaseio.PlanUpdate() # PlanUpdate | 

    try:
        # Update plan.
        api_response = api_instance.update_plan(code, id, plan_update)
        print("The response of PlansApi->update_plan:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->update_plan: %s\n" % e)

Parameters

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

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]

Files

PlansApi.md

Latest commit

History

PlansApi.md

File metadata and controls

qaseio.PlansApi

create_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_plans

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details