Augmentir API

Augmentir.py

import requests
from typing import List, Dict


class _Jobs:
    def __init__(self, api_key, base_url):
        self._api_key = api_key
        self._base_url = base_url

    def get_jobs_from_procedure(self, procedure_id: str = "", procedure_name: str = "", start_date: str = "", end_date: str = "", status: str = "", exclude_archived: bool = True, limit: int = 100, pagingupdate: bool = True):
        url = "/rest/v1/GetJobsFromProcedure"
        payload = {
            "procedureId": procedure_id,
            "procedureName": procedure_name,
            "startDate": start_date,
            "endDate": end_date,
            "status": status,
            "excludeArchived": exclude_archived,
            "limit": limit,
            "pagingupdate": pagingupdate,
        }
        response = requests.post(
            self._base_url + url, headers={'x-aug-api-key': self._api_key}, json=payload)
        return response.json()

    def get_jobs_status(self, job_ids: List[str]):
        url = "/rest/v1/GetJobsStatus"
        payload = {
            "jobIds": job_ids
        }
        response = requests.post(
            self._base_url + url, headers={'x-aug-api-key': self._api_key}, json=payload)
        return response.json()

    def create_job_from_procedure(self, procedure_name: str = "", procedure_id: str = "", assigned_user_email: str = "", assigned_user_id: str = "", assigned_group_name: str = "",assigned_group_id: str = "", publish_state: str = "", procedure_version: str = "", use_latest_draft: bool = False, data: Dict = {}):
        url = "/rest/v1/CreateJobFromProcedure"
        payload = {
            "procedureName": procedure_name,
            "procedureId": procedure_id,
            "assignedUserEmail": assigned_user_email,
            "assignedUserId": assigned_user_id,
            "assignedStationName": "",
            "assignedStationId": "",
            "assignedGroupName": assigned_group_name,
            "assignedGroupId": assigned_group_id,
            "publishState": publish_state,
            "procedureVersion": "",
            "ignoreUnknownData": "",
            "useLatestDraft": use_latest_draft,
            "data": data,
            "procedureHelpers": []
        }
        response = requests.post(
            self._base_url + url, headers={'x-aug-api-key': self._api_key}, json=payload)
        return response.json()


class Augmentir:
    def __init__(self, api_key):
        self._api_key = api_key
        self._base_url = "https://app.augmentir.com"

        self.jobs = _Jobs(self._api_key, self._base_url)



# augmentirClient = Augmentir("xxxxxxxxxxxxxxxxxxx")

# result = augmentirClient.jobs.get_jobs_from_procedure(
#    procedure_name="VN11 - OE WALKABOUT FORM", limit=1)
# print(result)