job
JobDescription
JobDescription object that stores the description of a job.
get_categories(self)
Get categories defined for the job (e.g. good or bad).
Returns:
| Type | Description |
|---|---|
List[Dict[str, Any]] |
A list of category conditions. |
get_conditions(self, combine=False, include_events=False)
Get the job conditions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
combine |
|
Combine the conditions under a single condition. |
False |
include_events |
|
If True, it also includes the event conditions. |
False |
Returns:
| Type | Description |
|---|---|
List[Dict[str, Any]] |
A List of conditions. |
get_data(self, filters=None)
Get the filtered data used in the job.
Warning: As for now the webservice does not have access to the actual job data. This function accesses the data from the memory base with the same filters as when the job data were created but might return different data if the actual data have been updated in the memory base but not in the job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filters |
List[Dict[str, Any]] |
List of filters to apply to the request. |
None |
Returns:
| Type | Description |
|---|---|
Dict[str, Any] |
A dictionary of filtered data list. |
get_events(self)
Get the events used in the job.
Returns:
| Type | Description |
|---|---|
Dict[str, List[Event]] |
A list of events. |
get_rule(self, bcid)
Get a rule description from its bcId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bcid |
str |
Rule bcid. |
required |
Returns:
| Type | Description |
|---|---|
RuleDescription |
A Rule description. |
get_rule_list(self, **kwargs)
Get a list a of rule descriptions from a list of ids.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs |
|
Optional page and page_size. |
{} |
Returns:
| Type | Description |
|---|---|
RuleDescription |
A list of Rule descriptions. |
get_variable_ids(self)
Get a list a of the variable bcIds used by the job.
The list of variable includes the actual job variables and the condition variables.
Returns:
| Type | Description |
|---|---|
List[str] |
A list of variables bcIds. |