Project Queries

The EC3Projects class can be used for retrieving project records in the EC3 database.

Usage of this class assumes that you have projects setup already in your EC3 account. The simplest method for returning projects will likely be by using the get_project_by_name method.

Users should refer to the EC3 documentation for the field names and values expected for projects.

EC3Projects

class ec3.ec3_projects.EC3Projects(bearer_token, response_format='json', ssl_verify=True)

Wraps functionality of EC3 Projects

Variables

sort_by (str) – Optional name of return field to sort results by, defaults to “”

Usage:

>>> ec3_project_list = EC3Projects(bearer_token=token, ssl_verify=False)
>>> ec3_project_list.get_projects(params=project_param_dict)

get_project_by_id(project_id)

Returns the project from a project id

Parameters

project_id (str) – Entity ID

Returns

List of dictionaries of matching Project records

Return type

list

get_projects(return_all=False, **params)

Returns matching Projects in your EC3 account

Parameters

return_all (bool, optional) – Set to True to return all matches. Defaults to False, which will return the quantity specified in page_size.

Returns

List of dictionaries of matching Project records

Return type

list

get_projects_by_name(project_name)

Returns a list of projects with a name equivalent to the input If your exact project name is put here you should get a list with one item.

Parameters

project_name (str) – Search term for your EC3 project name

Returns

List of dictionaries of matching Project records

Return type

list