Manage dataitems
The CRUD methods are used to read, update, and delete dataitems. They can be called through the SDK or through the Project object. When managing dataitems from a project, omit the project parameter and pass every other parameter as a keyword argument. For dataitem creation functions, see the Create a dataitem guide.
Read
Use the read methods to retrieve dataitems from the backend or load them from a YAML descriptor.
get_dataitem
Get a dataitem entity from the backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
identifier
|
str
|
Entity name or entity key ( |
required |
project
|
str
|
Project name. Required when |
None
|
entity_id
|
str
|
Entity identifier. If omitted, the latest version is returned. |
None
|
Returns:
| Type | Description |
|---|---|
Dataitem
|
Retrieved dataitem entity. |
get_dataitem_versions
Get all versions of a dataitem entity from the backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
identifier
|
str
|
Entity name or entity key ( |
required |
project
|
str
|
Project name. Required when |
None
|
Returns:
| Type | Description |
|---|---|
list[Dataitem]
|
All versions of the dataitem entity. |
list_dataitems
List dataitem entities in a project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project
|
str
|
Project name. |
required |
q
|
str
|
Query string used to filter entities. |
None
|
name
|
str
|
Entity name used to filter results. |
None
|
kind
|
str
|
Entity kind used to filter results. |
None
|
labels
|
list[str]
|
Labels used to filter results. |
None
|
user
|
str
|
User who created the entity. |
None
|
state
|
str
|
Entity state used to filter results. |
None
|
created
|
str
|
Creation date filter. |
None
|
updated
|
str
|
Update date filter. |
None
|
versions
|
str
|
Version filter. Defaults to the latest version. |
None
|
Returns:
| Type | Description |
|---|---|
list[Dataitem]
|
Dataitem entities matching the filters. |
import_dataitem
Import a dataitem entity from a YAML file or entity key.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file
|
str
|
Path to a YAML file containing the entity descriptor. Provide either
|
None
|
key
|
str
|
Entity key ( |
None
|
reset_id
|
bool
|
Whether to generate a new entity identifier instead of preserving the identifier from the imported entity. |
False
|
context
|
str
|
Project name used for context resolution. If omitted, the project from the entity descriptor is used. |
None
|
Returns:
| Type | Description |
|---|---|
Dataitem
|
Imported dataitem entity. |
load_dataitem
Load a dataitem entity from a YAML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file
|
str
|
Path to a YAML file containing the entity descriptor. |
required |
Returns:
| Type | Description |
|---|---|
Dataitem
|
Loaded dataitem entity. An existing entity is updated when it can be identified; otherwise, a new entity is created. |
Update
Update a dataitem after changing its mutable metadata.
update_dataitem
Update a dataitem entity in the backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
Dataitem
|
Entity to update. The entity specification is immutable. |
required |
Returns:
| Type | Description |
|---|---|
Dataitem
|
Updated dataitem entity. |
Delete
Delete one dataitem version or all versions of a dataitem.
delete_dataitem
Delete one or more versions of a dataitem entity from the backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
identifier
|
str
|
Entity name or entity key ( |
required |
project
|
str
|
Project name. Required when |
None
|
entity_id
|
str
|
Identifier of the version to delete. Required when
|
None
|
delete_all_versions
|
bool
|
Whether to delete all versions of the named entity. When False, only one version is deleted. |
False
|
cascade
|
bool
|
Whether to request cascade deletion from the backend. |
True
|
**kwargs
|
dict
|
Additional parameters to pass to the API call. |
{}
|
Returns:
| Type | Description |
|---|---|
dict
|
Response data from the backend. |