Skip to content

JobService

JobService(rest)

Bases: ObjectService

Service to handle TM1 Job objects introduced in v12

Source code in TM1py/Services/JobService.py 
16
17
def __init__(self, rest: RestService):
    super().__init__(rest)

cancel(job_id, **kwargs)

Cancels a running Job

Parameters:

Name Type Description Default
job_id
required

Returns:

Type Description
Source code in TM1py/Services/JobService.py 
30
31
32
33
34
35
36
37
38
39
@require_version(version="12.0.0")
def cancel(self, job_id, **kwargs):
    """Cancels a running Job

    :param job_id:
    :return:
    """
    url = format_url("/Jobs('{}')/tm1.Cancel", str(job_id))
    response = self._rest.POST(url, **kwargs)
    return response

cancel_all(**kwargs)

Source code in TM1py/Services/JobService.py 
41
42
43
44
45
46
47
48
@require_version(version="12.0.0")
def cancel_all(self, **kwargs):
    jobs = self.get_all()
    canceled_jobs = list()
    for job in jobs:
        self.cancel(job["ID"])
        canceled_jobs.append(job)
    return canceled_jobs

get_all(**kwargs)

Return a dict of the currently running jobs from the TM1 Server

Returns:

Type Description

dict: the response
Source code in TM1py/Services/JobService.py 
19
20
21
22
23
24
25
26
27
28
@require_version(version="12.0.0")
def get_all(self, **kwargs):
    """Return a dict of the currently running jobs from the TM1 Server

    :return:
        dict: the response
    """
    url = "/Jobs"
    response = self._rest.GET(url, **kwargs)
    return response.json()["value"]

get_as_dataframe()

Gets jobs and returns them as a dataframe

Source code in TM1py/Services/JobService.py 
50
51
52
53
54
55
56
@require_pandas
@require_version(version="12.0.0")
def get_as_dataframe(self):
    """Gets jobs and returns them as a dataframe"""
    jobs = self.get_all()
    df = pd.DataFrame.from_records(jobs)
    return df