Entity Lists

Entity List-related functionality is accessed through client.entity_lists.

For example:

from pyodk.client import Client

client = Client()
data = client.entity_lists.list()

Conceptually, an EntityList's parent object is a Project. Each Project may have multiple EntityLists.

create(approval_required=False, entity_list_name=None, project_id=None)

Create an Entity List.

Parameters:

Name	Type	Description	Default
approval_required	bool | None	If False, create Entities as soon as Submissions are received by Central. If True, create Entities when Submissions are marked as Approved in Central.	False
entity_list_name	str | None	The name of the Entity List (Dataset) being referenced.	None
project_id	int | None	The id of the project this Entity List belongs to.	None

get(entity_list_name=None, project_id=None)

Read Entity List details.

Parameters:

Name	Type	Description	Default
project_id	int | None	The id of the project the Entity List belongs to.	None
entity_list_name	str | None	The name of the Entity List (Dataset) being referenced.	None

Returns:

Type	Description
EntityList	An object representation of all Entity Lists' details.

list(project_id=None)

Read all Entity List details.

Parameters:

Name	Type	Description	Default
project_id	int | None	The id of the project the Entity List belongs to.	None

Returns:

Type	Description
list[EntityList]	A list of the object representation of all Entity Lists' details.