qaseio.ProjectsApi

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

Method	HTTP request	Description
create_project	POST /project	Create new project.
delete_project	DELETE /project/{code}	Delete Project by code.
get_project	GET /project/{code}	Get Project by code.
get_projects	GET /project	Get All Projects.
grant_access_to_project	POST /project/{code}/access	Grant access to project by code.
revoke_access_to_project	DELETE /project/{code}/access	Revoke access to project by code.

create_project

ProjectCodeResponse create_project(project_create)

Create new project.

This method is used to create a new project through API.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.project_code_response import ProjectCodeResponse
from qaseio.models.project_create import ProjectCreate
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.ProjectsApi(api_client)
    project_create = qaseio.ProjectCreate() # ProjectCreate | 

    try:
        # Create new project.
        api_response = api_instance.create_project(project_create)
        print("The response of ProjectsApi->create_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsApi->create_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_create	ProjectCreate

Return type

ProjectCodeResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

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

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

delete_project

BaseResponse delete_project(code)

Delete Project by code.

This method allows to delete a specific project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.base_response import BaseResponse
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.ProjectsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.

    try:
        # Delete Project by code.
        api_response = api_instance.delete_project(code)
        print("The response of ProjectsApi->delete_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsApi->delete_project: %s\n" % e)

Parameters

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

Return type

BaseResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A result of project removal.	-
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_project

ProjectResponse get_project(code)

Get Project by code.

This method allows to retrieve a specific project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.project_response import ProjectResponse
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.ProjectsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.

    try:
        # Get Project by code.
        api_response = api_instance.get_project(code)
        print("The response of ProjectsApi->get_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsApi->get_project: %s\n" % e)

Parameters

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

Return type

ProjectResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

ProjectListResponse get_projects(limit=limit, offset=offset)

Get All Projects.

This method allows to retrieve all projects available for your account. You can limit and offset params to paginate.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.project_list_response import ProjectListResponse
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.ProjectsApi(api_client)
    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 Projects.
        api_response = api_instance.get_projects(limit=limit, offset=offset)
        print("The response of ProjectsApi->get_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsApi->get_projects: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

ProjectListResponse

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 projects.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
429	Too Many Requests.	-

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

grant_access_to_project

BaseResponse grant_access_to_project(code, project_access)

Grant access to project by code.

This method allows to grant access to a specific project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.base_response import BaseResponse
from qaseio.models.project_access import ProjectAccess
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.ProjectsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    project_access = qaseio.ProjectAccess() # ProjectAccess | 

    try:
        # Grant access to project by code.
        api_response = api_instance.grant_access_to_project(code, project_access)
        print("The response of ProjectsApi->grant_access_to_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsApi->grant_access_to_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
project_access	ProjectAccess

Return type

BaseResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Result of operation.	-
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]

revoke_access_to_project

BaseResponse revoke_access_to_project(code, project_access)

Revoke access to project by code.

This method allows to revoke access to a specific project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.base_response import BaseResponse
from qaseio.models.project_access import ProjectAccess
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.ProjectsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    project_access = qaseio.ProjectAccess() # ProjectAccess | 

    try:
        # Revoke access to project by code.
        api_response = api_instance.revoke_access_to_project(code, project_access)
        print("The response of ProjectsApi->revoke_access_to_project:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProjectsApi->revoke_access_to_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
project_access	ProjectAccess

Return type

BaseResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Result of operation.	-
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

ProjectsApi.md

Latest commit

History

ProjectsApi.md

File metadata and controls

qaseio.ProjectsApi

create_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_projects

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

grant_access_to_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

revoke_access_to_project

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details