Skip to content

Project module

ProjectActions

Bases: BaseAction

Projects actions

projects(id_in=None, status_in=None, type_in=None, search=None, disable_progress_bar=False, iterate=False)

Get a projects list

Parameters:

Name Type Description Default
id_in Optional[List[str]]

ID of the projects

None
status_in Optional[List[str]]

Only in those statuses. Possible choices: configuring, pending, complete, toBeDeleted, deleted, archived.

None
type_in Optional[List[str]]

Only in those statuses. Possible choices: form, iat-rectangle, iat-polygon, iat-segmentation, iat-graph, iat-polyline

None
search Optional[str]

Quicksearch,

None
disable_progress_bar Optional[bool]

Disable the progress bar display,

False
iterate Optional[bool]

Return a generator

False

Returns:

Type Description
Union[Generator[Iterable[Dict], None, None], Iterable[Dict]]

List (or Generator) of project representations