Metadata¶
arkindex_worker.worker.metadata ¶
ElementsWorker methods for metadata.
MetaType ¶
Bases: Enum
Type of a metadata.
HTML
class-attribute
¶
HTML = 'html'
A metadata with a string value that should be interpreted as HTML content. The allowed HTML tags are restricted for security reasons.
Date
class-attribute
¶
Date = 'date'
A metadata with a string value that should be interpreted as a date.
The date should be formatted as an ISO 8601 date (YYYY-MM-DD
).
Location
class-attribute
¶
Location = 'location'
A metadata with a string value that should be interpreted as a location.
Reference
class-attribute
¶
Reference = 'reference'
A metadata with a string value that should be interpreted as an external identifier to this element, for example to preserve a link to the original data before it was imported into Arkindex.
URL
class-attribute
¶
URL = 'url'
A metadata with a string value that should be interpreted as an URL.
Only the http
and https
schemes are allowed.
MetaDataMixin ¶
Bases: object
create_metadata ¶
create_metadata(element, type, name, value, entity=None)
Create a metadata on the given element through API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to create a metadata on. |
required |
type |
MetaType
|
Type of the metadata. |
required |
name |
str
|
Name of the metadata. |
required |
value |
str
|
Value of the metadata. |
required |
entity |
Optional[str]
|
UUID of an entity this metadata is related to. |
None
|
Returns:
Type | Description |
---|---|
str
|
UUID of the created metadata. |
Source code in arkindex_worker/worker/metadata.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
|
create_metadatas ¶
create_metadatas(element, metadatas)
Create multiple metadatas on an existing element. This method does not support cache.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
Element |
element
|
The element to create multiple metadata on. |
required |
List(Dict) |
metadata_list
|
The list of dict whose keys are the following: - type : MetaType - name : str - value : Union[str, Union[int, float]] - entity_id : Union[str, None] |
required |
Source code in arkindex_worker/worker/metadata.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
list_element_metadata ¶
list_element_metadata(element)
List all metadata linked to an element. This method does not support cache.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to list metadata on. |
required |
Source code in arkindex_worker/worker/metadata.py
190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
|
create_metadata ¶
create_metadata(element, type, name, value, entity=None)
Create a metadata on the given element through API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to create a metadata on. |
required |
type |
MetaType
|
Type of the metadata. |
required |
name |
str
|
Name of the metadata. |
required |
value |
str
|
Value of the metadata. |
required |
entity |
Optional[str]
|
UUID of an entity this metadata is related to. |
None
|
Returns:
Type | Description |
---|---|
str
|
UUID of the created metadata. |
Source code in arkindex_worker/worker/metadata.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
|
create_metadatas ¶
create_metadatas(element, metadatas)
Create multiple metadatas on an existing element. This method does not support cache.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
Element |
element
|
The element to create multiple metadata on. |
required |
List(Dict) |
metadata_list
|
The list of dict whose keys are the following: - type : MetaType - name : str - value : Union[str, Union[int, float]] - entity_id : Union[str, None] |
required |
Source code in arkindex_worker/worker/metadata.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
list_element_metadata ¶
list_element_metadata(element)
List all metadata linked to an element. This method does not support cache.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to list metadata on. |
required |
Source code in arkindex_worker/worker/metadata.py
190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
|